postgrester v2.1.1

postgrester

Isomorphic PostgREST API Client for Javascript and Typescript.

Supported PostgREST versions:

• v9.0.0
• v8.0.0

• Gettting Started
• Example
• API
  • Options
  • Vertical Filtering (columns) Methods
    • select()
  • Hoizontal Filtering (rows) Methods
    • is()
    • eq()
    • neq()
    • gt()
    • gte()
    • lt()
    • lte()
    • in()
    • like()
    • ilike()
    • not
    • and
    • or
  • Ordering Methods
    • orderBy()
  • Pagination Methods
    • page()
  • Request Methods
    • get()
    • post() / Insert
    • post() / Upsert
    • patch()
    • put()
    • delete()
• Contribute
• License

Gettting Started

npm i postgrester

Example

import { create } from "postgrester";

const postgrestClient = create({
  axiosConfig: { baseURL: "https://api.example.com" }
});

(async () => {
  const { data, pagesLength } = await postgrestClient
    .select("*")
    .select("author(first_name,last_name)")
    .is("is_published", true)
    .not.is("isbn", null)
    .eq("publication_year", 1970)
    .in("language_code", ["en-UK", "en-US"])
    .ilike("title", "island")
    .like("author.last_name", "Hemingway")
    .orderBy("publication_year", true) // `true` = DESC
    .orderBy("title")
    .page(3, 25) // 4th page with 25 items per page
    .get("/books", true); // `true` = require the total `pagesLength` value to be calculated
})();

API

Options

When creating the instance via create([options]):

:warning: If you provide an axios instance via the axiosInstance property, it's useless to set axiosConfig since it would be overridden by your instance.

:warning: baseUri takes precedence over axiosConfig.baseURL. To avoid any confusion, baseUri will be deprecated in the next minor version release and should be removed in the next major one.

Vertical Filtering (columns) Methods

select()

You can also rename them by inserting a colon: original_column_name:new_column_name.

Hoizontal Filtering (rows) Methods

is()

eq()

Note: boolean and null values will be converted into an is().

neq()

Note: boolean and null values will be converted into a negated is().

gt()

gte()

Note: This method is an alias for gt() with <isInclusive> set to true.

lt()

lte()

Note: This method is an alias for lt() with <isInclusive> set to true.

in()

like()

ilike()

not

This getter ONLY negates the FIRST following filtering method.

For example, postgrestClient.not.is("category_id", null).ilike("author", "dostoevsky") will negate the is() filter but not the ilike() one.

and

This getter condition ALL the following filtering methods to be conjuncted as "ands".

For example, postgrestClient.and.is("category_id", null).ilike("author", "dostoevsky") will intersect both is() and ilike() filters.

or

This getter condition ALL the following filtering methods to be conjuncted as "ors".

For example, postgrestClient.and.is("category_id", null).ilike("author", "dostoevsky") will unite both is() and ilike() filters.

Ordering Methods

orderBy()

Pagination Methods

page()

Request Methods

All request methods are asynchronous promises.

get()

Return value:

Promise<{
  data: any;
  pagesLength: number;
  totalLength: number;
}>

:warning: Important Both pagesLength and totalLength will equal -1 if <withPagesLength> parameter is false or if the length couldn't be resolved.

post() / Insert

Return value:

Promise<void>

or (with { return: "representation" }):

Promise<{
  data: T
}>

post() / Upsert

:warning: Important
If data is an array, it will be considered as an upsert.
In this case, if you don't specify otherwise in options, merge-duplicates resolution will be used by default.

Return value:

Promise<void>

or (with { return: "representation" }):

Promise<{
  data: T[]
}>

patch()

Return value:

Promise<void>

put()

Return value:

Promise<void>

delete()

Return value:

Promise<void>

or (with { return: "representation" }):

Promise<{
  data: T[]
}>

Contribute

Please check our contributing documentation.

License

This package and its sources are distributed under Apache 2.0.