⚠️ This package is deprecated. v2 is the final release. No future versions will be published.

Skip to content

Main Navigation Learn API Reference Blog

Versioning Policy

Sidebar Navigation

Configs

API configs

Pino (logger) configs

Rate limit configs

Database configs

Cache configs

Redis configs

Elasticsearch configs

Search configs

Version configs

Initialization

onBeforeInit()

onAfterInit()

Axe API

App

IContext

AxeRequest

AxeResponse

IoC

ApiError

Error Codes

Models

table()

primaryKey()

fillable()

validations()

hiddens()

createdAtColumn()

updatedAtColumn()

deletedAtColumn()

handlers()

middlewares()

transactions()

limits()

cache()

search()

getSearchQuery()

ignore()

Handlers

Defaults

INSERT

PAGINATE

SHOW

UPDATE

DELETE

FORCE_DELETE

PATCH

ALL

SEARCH

Queries

fields

sort

page

per_page

trashed

q

with

Hooks & Events

onBeforeInsert()

onBeforeUpdateQuery()

onBeforeUpdate()

onBeforePatchQuery()

onBeforePatch()

onBeforeDeleteQuery()

onBeforeDelete()

onBeforeForceDeleteQuery()

onBeforeForceDelete()

onBeforePaginate()

onBeforeAll()

onBeforeSearch()

onBeforeShow()

onAfterInsert()

onAfterUpdateQuery()

onAfterUpdate()

onAfterPatchQuery()

onAfterPatch()

onAfterDeleteQuery()

onAfterDelete()

onAfterForceDeleteQuery()

onAfterForceDelete()

onAfterPaginate()

onAfterAll()

onAfterSearch()

onAfterShow()

Axe API Client

setConfig()

addRequest()

addResponse()

first()

resource()

insert()

update()

patch()

delete()

paginate()

with()

where()

orWhere()

andWhere()

whereLike()

whereIn()

whereBetween()

whereNull()

On this page

`first()`

ts

import api from "axe-api-client";

// ...
const user = await api.find("users/1");

url: The resource URL.

Edit this page on GitHub

Pager

Previous pageaddResponse()

Next pageresource()

Released under the MIT License.

Copyright © 2020-present