osu-api-extended/dist/tools/country.d.ts

Advanced osu! api wrapper cover all V2 and V1 endpoints, and provide useful tools

import { IError } from "../types";
import { CountryResponse } from "../types/tools";
type Response = CountryResponse & IError;
/**
 * Get more information about the country by providing an name/code.
 *
 *  
 *
 * ### Parameters
 * - `name` - Name of the country or country code
 *
 *  
 *
 * ### Usage Example
 * ```js
 * const { tools } = require('osu-api-extended');
 *
 * function main() {
 *   try {
 *     const result = tools.country_details('US');
 *     // or
 *     const result = tools.country_details('United States');
 *     if (result.error != null) {
 *       console.log(result.error);
 *       return;
 *     };
 *
 *
 *     console.log(result);
 *   } catch (error) {
 *     console.log(error);
 *   };
 * };
 *
 * main();
 * ```
 */
export declare const country_details: (name: string) => Response;
export {};