Skip to content

类: LxnsMaimaiDatabase

定义于: packages/database/src/adapters/lxns/lxns-database.ts:74

MaimaiDatabaseLXNS 适配:公开 JSON API + 素材 CDN。

  • 无需玩家访问令牌(公开数据)
  • getChartTags 使用包内 DXRating 标签快照

示例

ts
const database = new LxnsMaimaiDatabase({
  cache: { store: new MemoryCacheStore({ maxEntries: 512 }), ttlMs: 300_000 },
});

实现

构造函数

构造函数

ts
new LxnsMaimaiDatabase(options?): LxnsMaimaiDatabase;

定义于: packages/database/src/adapters/lxns/lxns-database.ts:81

参数

参数类型
optionsLxnsMaimaiDatabaseOptions

返回

LxnsMaimaiDatabase

方法

getAliasList()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:126

曲目别名全表

返回

Promise<Alias[]>


getAsset()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:191

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

参数

参数类型
typeAssetType
idnumber

返回

Promise<Uint8Array<ArrayBufferLike>>

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


getChartTags()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:91

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

参数

参数类型
chartsreadonly ChartTagQuery[]

返回

Promise<ChartTag[][]>

charts 等长的二维数组


getCollectionGenreInfo()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:182

单个收藏品分类

参数

参数类型
idnumber
query?{ version?: number; }
query.version?number

返回

Promise<CollectionGenre>


getCollectionGenreList()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:171

收藏品分类列表

参数

参数类型
query?{ version?: number; }
query.version?number

返回

Promise<CollectionGenre[]>


getCollectionInfo()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:157

单个收藏品

参数

参数类型
typeCollectionType
idnumber
query?{ version?: number; }
query.version?number

返回

Promise<Collection>


getCollectionList()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:135

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

参数

参数类型
typeCollectionType
query?{ required?: boolean; version?: number; }
query.required?boolean
query.version?number

返回

Promise<Collection[]>


getSong()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:108

单曲详情

参数

参数类型
idnumber
query?{ version?: number; }
query.version?number

返回

Promise<Song>


getSongCollections()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:117

曲目关联收藏品

参数

参数类型
songIdnumber

返回

Promise<SongCollection[]>


getSongList()

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

定义于: packages/database/src/adapters/lxns/lxns-database.ts:95

曲目列表。

参数

参数类型
query?SongListQuery

返回

Promise<SongList>