---
title: BrexCore
editUrl: false
head: []
template: doc
prev: false
next: false
sidebar:
  hidden: false
  attrs: {}
pagefind: true
draft: false
---

Defined in: [src/core/client.ts:35](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L35)

The shared HTTP engine behind every generated resource class. Not part of
the typed API surface — use the `Brex` class or a per-API client instead.

## Constructors

### Constructor

> **new BrexCore**(`options`): `BrexCore`

Defined in: [src/core/client.ts:39](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L39)

#### Parameters

##### options

[`BrexOptions`](/brex/api/index/interfaces/brexoptions/)

#### Returns

`BrexCore`

## Methods

### list()

> **list**\<`P`\>(`path`, `args?`): [`PagePromise`](/brex/api/index/classes/pagepromise/)\<`P`\>

Defined in: [src/core/client.ts:91](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L91)

#### Type Parameters

##### P

`P` *extends* [`PageShape`](/brex/api/index/interfaces/pageshape/)

#### Parameters

##### path

`string`

##### args?

[`RequestArgs`](/brex/api/index/interfaces/requestargs/) = `{}`

#### Returns

[`PagePromise`](/brex/api/index/classes/pagepromise/)\<`P`\>

***

### request()

> **request**\<`T`\>(`method`, `path`, `args?`): `Promise`\<`T`\>

Defined in: [src/core/client.ts:50](https://github.com/slingshot/brex/blob/9dff46b5d5637a0dd072bca56d02d8a0f4425312/src/core/client.ts#L50)

#### Type Parameters

##### T

`T`

#### Parameters

##### method

`string`

##### path

`string`

##### args?

[`RequestArgs`](/brex/api/index/interfaces/requestargs/) = `{}`

#### Returns

`Promise`\<`T`\>