Interface MROptions

interface MROptions {
    authorization?: string;
    baseUrl?: string;
    cache?: null | NodeCache;
    userAgent?: string;
}

Properties

authorization? baseUrl? cache? userAgent?

Properties

Optionalauthorization

authorization?: string

Either a Personal Access Token or the Client secret when using the OAuth2 Authorization Flow

Default

undefined

OptionalbaseUrl

baseUrl?: string

The base URL of the Modrinth API

Default

'https://api.modrinth.com/v2'

Optionalcache

cache?: null | NodeCache

The cache instance to use for caching requests

OptionaluserAgent

userAgent?: 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)'

Settings

Member Visibility

On This Page

Properties