AuthEntity: toAuthorizationField()

Authorization ヘッダのフィールドに格納する文字列にフォーマットされた認証情報です。

返す文字列は IAuthKey.toAuthorizationField() の実装次第です。

この関数は非同期関数です。

構文

authEntity.toAuthorizationField(request) => Promise<(string | null)>

引数

• request: { method, url }

  認証を付与するリクエストオブジェクトです。

  • method: string

    リクエストのメソッドです。

  • url: string

    リクエストを送信する URL です。

返値: Promise<(string | null)>

認証情報を生成できればそれをフォーマットした文字列を、生成できなければ null を返すプロミスです。