dependabit / github-client/src / TokenAuthHandler

Class: TokenAuthHandler

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

Handler for token-based authentication (GitHub PAT, API keys)

Constructors

Constructor

new TokenAuthHandler(token): TokenAuthHandler;

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

Parameters

Parameter	Type
token	string

Returns

TokenAuthHandler

Methods

authenticate()

authenticate(): Promise<TokenAuth>;

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

Authenticate and return auth object

Returns

Promise<TokenAuth>

---

getToken()

getToken(): string;

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

Get current token

Returns

string

Warning

This method exposes the raw token value. Use with caution and avoid logging or displaying the token. Prefer using authenticate() for auth operations.

---

getType()

getType(): string;

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

Get authentication type

Returns

string

---

updateToken()

updateToken(newToken): void;

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

Update token (for rotation)

Parameters

Parameter	Type
newToken	string

Returns

void

---

validate()

validate(): boolean;

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

Validate token format

Returns

boolean