Skip to content

接口: MaimaiDatabase

定义于: packages/database/src/database.ts:51

游戏静态数据与素材访问接口(与具体数据服务无关)。

  • 包含:曲目、别名、收藏品、素材二进制、谱面社区标签等
  • 不包含:玩家成绩查询(见 @mai-kit/prober

各适配实现本接口;@mai-kit/draw 只依赖其中子集 (getAsset / getChartTags / 可选 getSongList)。

示例

ts
// db 为任意 MaimaiDatabase 实现
const list = await db.getSongList({ notes: true });
const jacket = await db.getAsset("jacket", songId);

方法

getAliasList()

ts
getAliasList(): Promise<Alias[]>;

定义于: packages/database/src/database.ts:71

曲目别名全表

返回

Promise<Alias[]>


getAsset()

ts
getAsset(type, id): Promise<Uint8Array<ArrayBufferLike>>;

定义于: packages/database/src/database.ts:89

素材二进制(封面 jacket、头像 icon、姓名框 plate、背景 frame、音乐等)。

参数

参数类型
typeAssetType
idnumber

返回

Promise<Uint8Array<ArrayBufferLike>>

原始字节,调用方自行解码或转 data URI


getChartTags()

ts
getChartTags(charts): Promise<ChartTag[][]>;

定义于: packages/database/src/database.ts:56

批量获取谱面社区标签(包内快照,不请求 DXRating 运行时)。

参数

参数类型
chartsreadonly ChartTagQuery[]

返回

Promise<ChartTag[][]>

charts 等长的二维数组


getCollectionGenreInfo()

ts
getCollectionGenreInfo(id, query?): Promise<CollectionGenre>;

定义于: packages/database/src/database.ts:83

单个收藏品分类

参数

参数类型
idnumber
query?VersionQuery

返回

Promise<CollectionGenre>


getCollectionGenreList()

ts
getCollectionGenreList(query?): Promise<CollectionGenre[]>;

定义于: packages/database/src/database.ts:80

收藏品分类列表

参数

参数类型
query?VersionQuery

返回

Promise<CollectionGenre[]>


getCollectionInfo()

ts
getCollectionInfo(
   type, 
   id, 
query?): Promise<Collection>;

定义于: packages/database/src/database.ts:77

单个收藏品

参数

参数类型
typeCollectionType
idnumber
query?VersionQuery

返回

Promise<Collection>


getCollectionList()

ts
getCollectionList(type, query?): Promise<Collection[]>;

定义于: packages/database/src/database.ts:74

某类收藏品列表(称号 / 头像 / 姓名框 / 背景)

参数

参数类型
typeCollectionType
query?CollectionListQuery

返回

Promise<Collection[]>


getSong()

ts
getSong(id, query?): Promise<Song>;

定义于: packages/database/src/database.ts:65

单曲详情

参数

参数类型
idnumber
query?VersionQuery

返回

Promise<Song>


getSongCollections()

ts
getSongCollections(songId): Promise<SongCollection[]>;

定义于: packages/database/src/database.ts:68

曲目关联收藏品

参数

参数类型
songIdnumber

返回

Promise<SongCollection[]>


getSongList()

ts
getSongList(query?): Promise<SongList>;

定义于: packages/database/src/database.ts:62

曲目列表。

参数

参数类型
query?SongListQuery

返回

Promise<SongList>