dependabit / github-client/src / BasicAuthHandler

Class: BasicAuthHandler

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

Handler for HTTP Basic authentication

Constructors

Constructor

new BasicAuthHandler(username, password): BasicAuthHandler;

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

Parameters

Parameter	Type
username	string
password	string

Returns

BasicAuthHandler

Methods

authenticate()

authenticate(): Promise<BasicAuth>;

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

Authenticate and return auth object

Returns

Promise<BasicAuth>

---

getAuthHeader()

getAuthHeader(): string;

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

Get base64-encoded Basic auth header value

Returns

string

---

getType()

getType(): string;

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

Get authentication type

Returns

string

---

toJSON()

toJSON(): Record<string, unknown>;

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

JSON representation (excludes password)

Returns

Record<string, unknown>

---

toString()

toString(): string;

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

String representation (masks password)

Returns

string

---

updateCredentials()

updateCredentials(username, password): void;

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

Update credentials (for rotation)

Parameters

Parameter	Type
username	string
password	string

Returns

void

---

validate()

validate(): boolean;

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

Validate credentials format

Returns

boolean