Skip to main content

Interface: AuthStrategy

Defined in: packages/client/src/core/auth.ts:21

Stable​

Properties​

name​

readonly name: string

Defined in: packages/client/src/core/auth.ts:22

Methods​

apply()​

apply(headers, req): void | Promise<void>

Defined in: packages/client/src/core/auth.ts:24

Mutate headers in place before the request is sent.

Parameters​

headers​

Record<string, string>

req​

FrappeRequestInfo

Returns​

void | Promise<void>

onResponse()?​

optional onResponse(headers, req): void | Promise<void>

Defined in: packages/client/src/core/auth.ts:29

Called after every response (success or failure) with the raw response headers. This is how a strategy observes Set-Cookie without the transport knowing anything about cookies.

Parameters​

headers​

Headers

req​

FrappeRequestInfo

Returns​

void | Promise<void>

onUnauthorized()?​

optional onUnauthorized(): boolean | Promise<boolean>

Defined in: packages/client/src/core/auth.ts:33

Called when a request comes back 401, before the taxonomy error is thrown. Return true to retry once.

Returns​

boolean | Promise<boolean>

reset()?​

optional reset(): void | Promise<void>

Defined in: packages/client/src/core/auth.ts:31

Called on logout / explicit reset. No-op by default.

Returns​

void | Promise<void>