Skip to main content

Class: AppleMusicConfig

Defined in: utils/Config.ts:46

Mutable configuration shared across endpoints for an AppleMusic client.

Constructors

Constructor

new AppleMusicConfig(config?: AppleMusicConfigParams): AppleMusicConfig;

Defined in: utils/Config.ts:52

Parameters

ParameterType
config?AppleMusicConfigParams

Returns

AppleMusicConfig

Methods

setRegion()

setRegion(region: Region): void;

Defined in: utils/Config.ts:62

Parameters

ParameterType
regionRegion

Returns

void


setAuthType()

setAuthType(authType: AuthType): void;

Defined in: utils/Config.ts:66

Parameters

ParameterType
authTypeAuthType

Returns

void


setLoggerOptions()

setLoggerOptions(options: LoggerOptions): void;

Defined in: utils/Config.ts:70

Parameters

ParameterType
optionsLoggerOptions

Returns

void


setLogger()

setLogger(logger: Logger): void;

Defined in: utils/Config.ts:75

Parameters

ParameterType
loggerLogger

Returns

void


getBaseURL()

getBaseURL(): string;

Defined in: utils/Config.ts:79

Returns

string


getBaseURLForAuthType()

getBaseURLForAuthType(authType: AuthType): string;

Defined in: utils/Config.ts:83

Parameters

ParameterType
authTypeAuthType

Returns

string

Properties

region

region: Region = Region.US;

Defined in: utils/Config.ts:47


authType

authType: AuthType = AuthType.Scraped;

Defined in: utils/Config.ts:48


logger

logger: Logger;

Defined in: utils/Config.ts:49


loggerOptions?

optional loggerOptions: LoggerOptions;

Defined in: utils/Config.ts:50