@quintype/backend

client for accessing quintype API

Source

npm

Version: 1.14.1

Version published: 7 years ago

Maintainers: 19

Created: 7 years ago

Source

@quintype/backend

This library is used for making API calls to a Quintype API server

How to use this library

It is highly recommended that you use the object wrappers for each API call. For example, please use

Story.getStoryBySlug(client, "slug").then(story => story.domainFunction())

rather than

// Do not use this
client.getStoryBySlug("slug").then(story => doSomethingWithStoryJson(story))

Return Values

In cases where a 404 is possible (such as getting a story or a collection by slug), the following return types are possible (taking Story.getStoryBySlug as an example)

In case of a success, the promise resolves to an object of the Story class
In case of a 404, such as a not found slug, the promise resolves to null
In case of a 5xx or any other status code, the promise is rejected with an exception

Keywords

quintype

FAQs

What is @quintype/backend?

Is @quintype/backend well maintained?

Package last updated on 19 Feb 2019

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install