dependabit / github-client/src / AuthManager

Class: AuthManager

Defined in: packages/github-client/src/auth.ts:24

Authentication manager that supports multiple auth methods

Constructors

Constructor

new AuthManager(config): AuthManager;

Defined in: packages/github-client/src/auth.ts:27

Parameters

Parameter	Type
config	AuthConfig

Returns

AuthManager

Methods

authenticate()

authenticate(code?): Promise<AuthResult>;

Defined in: packages/github-client/src/auth.ts:58

Perform authentication

Parameters

Parameter	Type
code?	string

Returns

Promise<AuthResult>

---

getHandler()

getHandler(): 
  | TokenAuthHandler
  | OAuthHandler
  | BasicAuthHandler;

Defined in: packages/github-client/src/auth.ts:85

Get underlying handler

Returns

| TokenAuthHandler | OAuthHandler | BasicAuthHandler

---

getType()

getType(): string;

Defined in: packages/github-client/src/auth.ts:78

Get authentication type

Returns

string

---

validate()

validate(): boolean;

Defined in: packages/github-client/src/auth.ts:71

Validate authentication configuration

Returns

boolean