Class CouchdbSessionAuthenticator

constructor

• new CouchdbSessionAuthenticator(
      options: CouchdbSessionAuthenticatorOptions,
  ): CouchdbSessionAuthenticator

  Create a new CouchdbSessionAuthenticator instance.

  Parameters

  • options: CouchdbSessionAuthenticatorOptions

    Configuration options for session authentication.

    Configuration options for CouchDB session authentication.

    • password: string

      The password to be used in CouchDB session authentication.

    • username: string

      The username to be used in CouchDB session authentication.

  Returns CouchdbSessionAuthenticator

  Throws

  The configuration options are not valid.

Static ReadonlyAUTHTYPE_COUCHDB_SESSION

authenticate

• authenticate(requestOptions: object): Promise<void>

  Acquire a session token that will be stored in a Cookie Jar. The same jar will be in use in the request.

  Parameters

  • requestOptions: object

    The request to augment with authentication information.

  Returns Promise<void>

authenticationType

• authenticationType(): string

  Returns the authenticator's type ('COUCHDB_SESSION').

  Returns string

  a string that indicates the authenticator's type

configure

• configure(userOptions: UserOptions): void

  Configure the TokenManager to use all the request settings together with the basic credentials.

  Parameters

  • userOptions: UserOptions

    Configuration values for a request service.

  Returns void