Class MetadataORM

Object Relation Mapper as an abstraction ontop of a local database connection.

May be used to populate a metadata database and query objects.

Hierarchy

MetadataORM

Index

Constructors

Properties

Methods

close findPlaylist findTrack insertEntity

Constructors

constructor

new MetadataORM(): MetadataORM
Returns MetadataORM
- Defined in src/localdb/orm.ts:52

Properties

`Private` #conn

#conn: Database

Methods

close

close(): void
Returns void
- Defined in src/localdb/orm.ts:57

findPlaylist

findPlaylist(playlistId?: number): {
    folders: Playlist[];
    playlists: Playlist[];
    trackEntries: PlaylistEntry<WithFKs>[];
}
Query for a list of {folders, playlists, tracks} given a playlist ID. If no ID is provided the root list is queried.

Note that when tracks are returned there will be no folders or playslists. But the API here is simpler to assume there could be.

Tracks are returned in the order they are placed on the playlist.
Parameters
- Optional playlistId: number
Returns {
    folders: Playlist[];
    playlists: Playlist[];
    trackEntries: PlaylistEntry<WithFKs>[];
}
- folders: Playlist[]
- playlists: Playlist[]
- trackEntries: PlaylistEntry<WithFKs>[]
- Defined in src/localdb/orm.ts:145

findTrack

findTrack(id: number): Track<WithRelations>
Locate a track by ID in the database
Parameters
- id: number
Returns Track<WithRelations>
- Defined in src/localdb/orm.ts:89

insertEntity

insertEntity(table: Table, object: Record<string, any>): void
Insert a entity object into the database.
Parameters
- table: Table
- object: Record<string, any>
Returns void
- Defined in src/localdb/orm.ts:64

Generated using TypeDoc