@not3/sdk
    Preparing search index...

    Class Not3Client

    Index

    Constructors

    Methods

    • Get the semver satisfying version range for the API.

      Returns string

      The version range.

    • Check if the API is compatible with this version of the SDK. If the API responds with the version 'IN-DEV', it is always considered compatible.

      Parameters

      • Optionalapi: SystemAPI

        The SystemAPI instance, used to keep the cache of the info response.

      Returns Promise<boolean>

      Whether the API is compatible.

    • Set the options for the client.

      Remember to not reuse the sub-clients after changing the options.

      const client = new Not3Client({ baseUrl: 'https://api.example.com/' });
      const files = client.files();
      client.setOptions({ baseUrl: 'https://api.example2.com/' });
      files.list(); // This will still call the old API

      Parameters

      Returns void

    • Update the options for the client.

      This will merge the new options with the existing ones.

      Parameters

      • options: Partial<ClientOptions>

        The options to update the client with.

      Returns void