@casbah/strapi-fetch v1.0.14

Strapi-Fetch

A cross-fetch wrapper for Strapi's API.

Install

npm i @casbah/strapi-fetch -S

Usage

Import strapi-fetch:

import * as strapi from '@casbah/strapi-fetch';

Get Users

const response = await strapi.get<User[]>(
  'https://www.project.com/users?confirmed=true'
);

if (response.ok) {
  const users = response.data;
} else {
  const error = response.error;
}

Create User

const response = await strapi.post('https://www.project.com/users', {
  email: 'someother@email.com',
});

if (response.ok) {
  console.log(response.data);
} else {
  console.log(response.error);
}

Update User

const response = await strapi.put('https://www.project.com/users/1', {
  email: 'someother@email.com',
});

if (response.ok) {
  console.log(response.data);
} else {
  console.log(response.error);
}

Delete User

const response = await strapi.del('https://www.project.com/users/1');

if (response.ok) {
  console.log(response.data);
} else {
  console.log(response.error);
}

Authentication

const auth = await strapi.auth(
  'https://www.project.com/auth/local',
  'some@email.com',
  'somepassword'
);

if (auth.ok) {
  const response = await strapi.get<User[]>(
    'https://www.project.com/users',
    auth.data.jwt // Use JWT in other methods
  );
} else {
  console.log(auth.messages);
}

The response object

Every strapi-fetch method returns the same type of object, whether the request is successful or not.

interface StrapiFetchResponse<T> {
  ok: boolean;
  status?: number;
  error?: string;
  messages: string[];
  data?: T;
}

When the request is successful, the ok property will be true, and the data property will hold Strapi's data.

When the request is not successful, the ok property will be false, an the error property will contain the details of the error or exception. For more user-friendly error messages (for instance, "Username or password incorrect") use the messages property.