typerinth/dist/interfaces/MROptions.d.ts

A TypeScript library for interacting with the Modrinth API.

import CacheOptions from './CacheOptions';
export default interface MROptions {
    /**
     * Either a [Personal Access Token](https://modrinth.com/settings/pats) or the Client secret when using the [OAuth2 Authorization Flow](https://docs.modrinth.com/api/#authentication)
     * @default undefined
     */
    authorization?: string;
    /**
     * The base URL of the Modrinth API
     * @default 'https://api.modrinth.com'
     */
    baseUrl?: string;
    /**
     * The API version to use
     * @default 'v2'
     */
    apiVersion?: string;
    /**
     * The user agent to use (**Recommended to change this** to avoid rate limiting)
     * * Bad: `typerinth (default user agent)`
     * * Good: `project_name`
     * * Better: `github_username/project_name/1.56.0`
     * * Best: `github_username/project_name/1.56.0 (launcher.com)` or `github_username/project_name/1.56.0 (contact@launcher.com)`
     *
     * @default 'typerinth (default user agent)'
     */
    userAgent?: string;
    /**
     * Cache options
     */
    cache?: CacheOptions;
}
export declare function getDefaultOptions(): MROptions;