Class MarketClient

constructor

• new MarketClient(config?: Partial<Config>): MarketClient

  Initializes a new instance of the class with the specified configuration.

  Parameters

  • Optionalconfig: Partial<Config>

    The configuration object, partially overriding default settings.

  Returns MarketClient

login

• login(params: LoginParams): Promise<UserCredentials>

  Authenticate the current instance and store the token, allowing to access the protected endpoints. Requires either username or email along with a password.

  Parameters

  • params: LoginParams

    Object with required fields.

  Returns Promise<UserCredentials>

  User's credentials.

  See

  Auth.login if you want to get credentials without setting the instance's token.

  Example

  await client.login({ email: 'user@example.com', password: 'prettynewpassword' })
  Copy

logout

• logout(): void

  Log out the current user by removing their authentication token.

  Returns void

useToken

• useToken(token: string): void

  Set or change the token value for the current instance.

  Parameters

  • token: string

    The token string to be set.

  Returns void

getToken

• getToken(): string | undefined

  Retrieve the current token value.

  Returns string | undefined

  The token if available, otherwise undefined.

useConfig

• useConfig(params: Partial<Config>): void

  Update the existing configuration by merging the provided partial configuration object.

  Parameters

  • params: Partial<Config>

    A partial configuration object containing the configuration properties to be updated.

  Returns void

getConfig

• getConfig(): Config

  Retrieve the current configuration object.

  Returns Config

  The configuration object.

Readonlyauth

Readonlymessages

Readonlypublications

Readonlyreviews

Readonlystatistics