feat: tsdoc for the definitions

This commit is contained in:
janishutz committed 2026-08-29 16:08:29 +02:00
1 parent bba6fd185e
commit 771f910636
3 files changed
+219 -7

No files matched your search

+13
View File
@@ -42,9 +42,22 @@ export interface MusicKitConfiguration {
}
export interface MusicKitObject {
/**
* Configure MusicKit
* @param config - Configuration of MusicKit
*/
'configure': ( config: MusicKitConfiguration ) => Promise<MusicKitInstance>;
/**
* Retrieve the MusicKit instance after configuring it.
*/
'getInstance': () => MusicKitInstance;
/**
* Format an artwork object to get the formatted URL.
* @param artwork - The artwork object as retrieved from the API
* @param width - The desired width of the artwork
* @param height - The desired height of the artwork
*/
'formatArtworkURL': ( artwork: Artwork, width: number, height: number ) => string;
}