CsrfOptionsBuilder

Defined in: src/http/middleware/CsrfOptions.ts:38

Fluent builder for CsrfOptionsType.

Extends

• OptionsBuilder<CsrfOptionsType>

Constructors

Constructor

new CsrfOptionsBuilder(): CsrfOptionsBuilder

Returns

CsrfOptionsBuilder

Inherited from

OptionsBuilder.constructor

Methods

build()

build(): Partial<T>

Defined in: src/util/OptionsBuilder.ts:51

Snapshot the set fields as an independent Partial<T> (own props only).

Returns

Partial<T>

Inherited from

OptionsBuilder.build

---

withAllowedOrigins()

withAllowedOrigins(…origins): this

Defined in: src/http/middleware/CsrfOptions.ts:57

Parameters

origins

…string[]

Returns

this

---

withCookie()

withCookie(cookie): this

Defined in: src/http/middleware/CsrfOptions.ts:51

Parameters

cookie

CsrfCookieOptions

Returns

this

---

withCookieName()

withCookieName(name): this

Defined in: src/http/middleware/CsrfOptions.ts:45

Parameters

name

string

Returns

this

---

withFormField()

withFormField(name): this

Defined in: src/http/middleware/CsrfOptions.ts:60

Parameters

name

string

Returns

this

---

withHeaderName()

withHeaderName(name): this

Defined in: src/http/middleware/CsrfOptions.ts:48

Parameters

name

string

Returns

this

---

withSecret()

withSecret(secret): this

Defined in: src/http/middleware/CsrfOptions.ts:42

Parameters

secret

string | Uint8Array<ArrayBufferLike>

Returns

this

---

withVerifyOrigin()

withVerifyOrigin(flag?): this

Defined in: src/http/middleware/CsrfOptions.ts:54

Parameters

flag?

boolean = true

Returns

this

---

create()

static create(): CsrfOptionsBuilder

Defined in: src/http/middleware/CsrfOptions.ts:39

Returns

CsrfOptionsBuilder