@syncfm/applemusic-api

Primary entry point for @syncfm/applemusic-api.

Apple Music Client

Class	Description
AppleMusic	High-level Apple Music API client composed of typed endpoint helpers.

Configuration

Name	Description
AuthType	Authentication modes supported by the Apple Music API client.
AppleMusicConfigParams	Parameters accepted by AppleMusicConfig.
AppleMusicConfig	Mutable configuration shared across endpoints for an AppleMusic client.

Endpoints

Class	Description
AlbumsEndpoint	Strongly-typed helper for the Apple Music albums endpoint.
ArtistsEndpoint	Strongly-typed helper for the Apple Music artists endpoint.
HintsEndpoint	Provides lightweight typeahead suggestions for search terms.
MusicVideosEndpoint	Strongly-typed helper for the Apple Music music video endpoint.
SearchEndpoint	Perform catalog-wide search queries with precise filtering.
SongsEndpoint	Strongly-typed helper for the Apple Music songs endpoint.
SuggestionsEndpoint	Retrieve query suggestions based on trending and historic search activity.

Endpoint Types

Namespace	Description
EndpointTypes/Albums	Type definitions supporting the Albums endpoint.
EndpointTypes/Artists	Type definitions supporting the Artists endpoint.
EndpointTypes/Hints	Type definitions supporting the Hints endpoint.
EndpointTypes/MusicVideos	Type definitions supporting the Music Videos endpoint.
EndpointTypes/Search	Type definitions supporting the Search endpoint.
EndpointTypes/Songs	Type definitions supporting the Songs endpoint.
EndpointTypes/Suggestions	Type definitions supporting the Suggestions endpoint.

Utilities

Class	Description
Logger	Lightweight multi-destination logger used throughout the client.

Other

Name	Description
Region	-
ResourceType	-
getAuthenticatedAxios	Get an Axios instance that automatically authenticates against Apple Music.
DestinationName	-
LogLevel	-