Type alias NpmRegistryClientConfig

NpmRegistryClientConfig: {
    basePath?: string;
    customServices?: {
        requestService?: RequestService;
    };
    hostname?: string;
    protocol?: "http" | "https";
}

The configuration options for the NpmRegistryClient

Type declaration

  • Optional basePath?: string

    The basePath to use for all requests

    Default

    '/downloads'
  • Optional customServices?: {
        requestService?: RequestService;
    }

    Options for customizing the services used by the API client. This is useful for testing as it allows you to mock the services.

    • Optional requestService?: RequestService

      The request service which is used to make requests to the API endpoint

      Default

      new RequestService()
  • Optional hostname?: string

    The hostname to use for all requests

    Default

    'api.npmjs.org'
  • Optional protocol?: "http" | "https"

    The protocol to use for all requests

    Default

    'https'

Settings

Member Visibility

Theme

Generated using TypeDoc