Function: default()

default(baseURL?, factoryOptions?): <Data, Body>(endpoint, options?) => Promise<GrabResult<Data>>

Defined in: packages/grabkit/src/grabkit.ts:29

Create a grab callable for METHOD /path requests.

Parameters

baseURL?

string

Origin prepended to relative paths.

factoryOptions?

GrabkitFactoryOptions

Default serialisation options for every grab from this factory.

Returns

<Data, Body>(endpoint, options?): Promise<GrabResult<Data>>

Perform a grab against endpoint.

Returns [data, error, meta]. Narrow with if (error); a truthy error means the grab failed.

Type Parameters

Data

Data = unknown

Body

Body = unknown

Parameters

endpoint

`GET https://${string}` | `GET http://${string}` | `GET /${string}` | `HEAD https://${string}` | `HEAD http://${string}` | `HEAD /${string}` | `POST https://${string}` | `POST http://${string}` | `POST /${string}` | `PUT https://${string}` | `PUT http://${string}` | `PUT /${string}` | `DELETE https://${string}` | `DELETE http://${string}` | `DELETE /${string}` | `CONNECT https://${string}` | `CONNECT http://${string}` | `CONNECT /${string}` | `OPTIONS https://${string}` | `OPTIONS http://${string}` | `OPTIONS /${string}` | `TRACE https://${string}` | `TRACE http://${string}` | `TRACE /${string}` | `PATCH https://${string}` | `PATCH http://${string}` | `PATCH /${string}`

METHOD path, e.g. GET /users/1.

options?

ClosureOptions<Body>

Per-call body, headers, and serialisation overrides.

Returns

Promise<GrabResult<Data>>

Example

const grab = grabkit('https://api.example.com', { casing: 'camelCase' });
const [data, error, meta] = await grab('GET /users/1');

if (error) {
  return;
}

console.log(data.name, meta.statusCode);