faasjs/faasjs

View on GitHub
packages/vue-plugin/type-aliases/Options.md

Summary

Maintainability
Test Coverage
[@faasjs/vue-plugin](../README.md) / Options

# Type alias: Options

> **Options**: `RequestInit` & `object`

## Type declaration

### beforeRequest()?

> `optional` **beforeRequest**: (`{
    action,
    params,
    options,
    headers,
  }`) => `Promise`\<`void`\>

trigger before request

#### Parameters

• **\{
    action,
    params,
    options,
    headers,
  \}**

• **\{
    action,
    params,
    options,
    headers,
  \}.action**: `string`

• **\{
    action,
    params,
    options,
    headers,
  \}.headers**: `Record`\<`string`, `string`\>

• **\{
    action,
    params,
    options,
    headers,
  \}.options**: [`Options`](Options.md)

• **\{
    action,
    params,
    options,
    headers,
  \}.params**: `Record`\<`string`, `any`\>

#### Returns

`Promise`\<`void`\>

### headers?

> `optional` **headers**: `Record`\<`string`, `string`\>

### request()?

> `optional` **request**: \<`PathOrData`\>(`url`, `options`) => `Promise`\<[`Response`](../classes/Response.md)\<`FaasData`\<`PathOrData`\>\>\>

custom request

#### Type parameters

• **PathOrData** *extends* `FaasAction`

#### Parameters

• **url**: `string`

• **options**: [`Options`](Options.md)

#### Returns

`Promise`\<[`Response`](../classes/Response.md)\<`FaasData`\<`PathOrData`\>\>\>