Skip to content
Last Updated
Mar 28, 2025, 03:08

Class ModrinthV2Client ​

🏭 Constructors ​

constructor ​

ts
ModrinthV2Client(options: ModrinthClientOptions): ModrinthV2Client

Parameters ​

  • options: ModrinthClientOptions

Return Type ​

  • ModrinthV2Client

Defined in: packages/modrinth/index.ts:185

🏷️ Properties ​

headers ​

ts
headers: Record<string, string>

Defined in: packages/modrinth/index.ts:183

🔧 Methods ​

getCategoryTags ​

ts
getCategoryTags(signal: AbortSignal): Promise<Category[]>

Parameters ​

  • signal: AbortSignal

Return Type ​

  • Promise<Category[]>

Defined in: packages/modrinth/index.ts:387

getGameVersionTags ​

ts
getGameVersionTags(signal: AbortSignal): Promise<GameVersion[]>

Parameters ​

  • signal: AbortSignal

Return Type ​

  • Promise<GameVersion[]>

Defined in: packages/modrinth/index.ts:403

getLatestProjectVersion ​

ts
getLatestProjectVersion(sha1: string, __namedParameters: { algorithm?: string; gameVersions?: string[]; loaders?: string[] }= {}, signal: AbortSignal): Promise<ProjectVersion>

Parameters ​

  • sha1: string
  • __namedParameters: { algorithm?: string; gameVersions?: string[]; loaders?: string[] }
  • signal: AbortSignal

Return Type ​

  • Promise<ProjectVersion>

Defined in: packages/modrinth/index.ts:349

getLatestVersionsFromHashes ​

ts
getLatestVersionsFromHashes(hashes: string[], __namedParameters: { algorithm?: string; gameVersions?: string[]; loaders?: string[] }= {}, signal: AbortSignal): Promise<Record<string, ProjectVersion>>

Parameters ​

  • hashes: string[]
  • __namedParameters: { algorithm?: string; gameVersions?: string[]; loaders?: string[] }
  • signal: AbortSignal

Return Type ​

  • Promise<Record<string, ProjectVersion>>

Defined in: packages/modrinth/index.ts:326

getLicenseTags ​

ts
getLicenseTags(signal: AbortSignal): Promise<License[]>

Parameters ​

  • signal: AbortSignal

Return Type ​

  • Promise<License[]>

Defined in: packages/modrinth/index.ts:371

getLoaderTags ​

ts
getLoaderTags(signal: AbortSignal): Promise<Loader[]>

Parameters ​

  • signal: AbortSignal

Return Type ​

  • Promise<Loader[]>

Defined in: packages/modrinth/index.ts:419

getProject ​

ts
getProject(projectId: string, signal: AbortSignal): Promise<Project>

Parameters ​

  • projectId: string
  • signal: AbortSignal

Return Type ​

  • Promise<Project>

Defined in: packages/modrinth/index.ts:216

getProjects ​

ts
getProjects(projectIds: string[], signal: AbortSignal): Promise<Project[]>

Parameters ​

  • projectIds: string[]
  • signal: AbortSignal

Return Type ​

  • Promise<Project[]>

Defined in: packages/modrinth/index.ts:233

getProjectTeamMembers ​

ts
getProjectTeamMembers(projectId: string, signal: AbortSignal): Promise<TeamMember[]>

Parameters ​

  • projectId: string
  • signal: AbortSignal

Return Type ​

  • Promise<TeamMember[]>

Defined in: packages/modrinth/index.ts:435

getProjectVersion ​

ts
getProjectVersion(versionId: string, signal: AbortSignal): Promise<ProjectVersion>

Parameters ​

  • versionId: string
  • signal: AbortSignal

Return Type ​

  • Promise<ProjectVersion>

Defined in: packages/modrinth/index.ts:269

getProjectVersions ​

ts
getProjectVersions(projectId: string, __namedParameters: { featured?: boolean; gameVersions?: string[]; loaders?: string[] }= {}, signal: AbortSignal): Promise<ProjectVersion[]>

Parameters ​

  • projectId: string
  • __namedParameters: { featured?: boolean; gameVersions?: string[]; loaders?: string[] }
  • signal: AbortSignal

Return Type ​

  • Promise<ProjectVersion[]>

Defined in: packages/modrinth/index.ts:250

getProjectVersionsByHash ​

ts
getProjectVersionsByHash(hashes: string[], algorithm: string= 'sha1', signal: AbortSignal): Promise<Record<string, ProjectVersion>>

Parameters ​

  • hashes: string[]
  • algorithm: string
  • signal: AbortSignal

Return Type ​

  • Promise<Record<string, ProjectVersion>>

Defined in: packages/modrinth/index.ts:302

getProjectVersionsById ​

ts
getProjectVersionsById(ids: string[], signal: AbortSignal): Promise<ProjectVersion[]>

Parameters ​

  • ids: string[]
  • signal: AbortSignal

Return Type ​

  • Promise<ProjectVersion[]>

Defined in: packages/modrinth/index.ts:285

getUser ​

ts
getUser(id: string, signal: AbortSignal): Promise<User>

Parameters ​

  • id: string
  • signal: AbortSignal

Return Type ​

  • Promise<User>

Defined in: packages/modrinth/index.ts:451

getUserProjects ​

ts
getUserProjects(id: string, signal: AbortSignal): Promise<Project[]>

Parameters ​

  • id: string
  • signal: AbortSignal

Return Type ​

  • Promise<Project[]>

Defined in: packages/modrinth/index.ts:467

searchProjects ​

ts
searchProjects(options: SearchProjectOptions, signal: AbortSignal): Promise<SearchResult>

Parameters ​

  • options: SearchProjectOptions
  • signal: AbortSignal

Return Type ​

  • Promise<SearchResult>

Defined in: packages/modrinth/index.ts:194