Standard Resource
  • Introduction
  • Read Me
  • Introduction
    • Motivation
    • Core Concepts
  • Store
    • Creating a Store
  • Resources
    • Resource Data
    • Creating
    • Retrieving
    • Updating
    • Deleting
    • Using Computed Attributes
    • Schemas
  • Groups
    • Creating
    • Retrieving
    • Updating
    • Deleting
    • Sorted Groups
  • API Reference
    • createResourceStore
    • Store
  • Glossary
  • Changelog
Powered by GitBook
On this page
  • Creating a Single Resource
  • Creating Multiple Resources
  • Creating with a Group
  1. Resources

Creating

PreviousResource DataNextRetrieving

Last updated 7 years ago

Use to create a resource.

Creating a Single Resource

You can use the first argument of update to specify the exact resource that you wish to create.

In the following code, we create a resource of type "books" with an ID of "24".

store.update('resources.books.24', [
  {
    attributes: {
      name: 'The Fellowship of the Ring',
      publishYear: 1940,
    },
  },
]);

Note that the following code is using the string "24" as the ID, rather than the number 24. If you wish to make the ID a number, be sure to also specify it in the resource object as well. Otherwise, it will be created as a string.

In this next example, the resource will be created with a numeric ID of 24:

store.update('resources.books.24', [
  {
    id: 24,
    attributes: {
      name: 'The Fellowship of the Ring',
      publishYear: 1940,
    },
  },
]);

Creating Multiple Resources

There are several ways to create multiple resources at a time. One way is to pass an array of resources:

store.update('resources.books', [
  {
    id: 24,
    attributes: {
      name: 'The Fellowship of the Ring',
      publishYear: 1940,
    },
  },
  {
    id: 102,
    attributes: {
      name: 'Harry Potter',
      publishYear: 1997,
    },
  },
]);

Another way is to provide an object with keys that are the IDs:

store.update('resources.books', {
  24: {
    id: 24,
    attributes: {
      name: 'The Fellowship of the Ring',
      publishYear: 1940,
    },
  },
  102: {
    id: 102,
    attributes: {
      name: 'Harry Potter',
      publishYear: 1997,
    },
  },
});

Note: the ID is duplicated within the resource definition to indicate that it is a number, and not a string.

Creating with a Group

You can also create resources when you update a group. Any resources that you place in a group will be created if they don't already exist in the store.

This can be useful if you want to create a resource and add it to a group in the same operation.

In the following example, we create a book with an ID of 24 and add it to the list of favorite books:

const newBook = {
  id: 24,
  attributes: {
    name: 'Harry Potter',
    publishYear: 1997,
  },
};

store.update('groups.favoriteBooks', [newBook], {
  concatGroups: true,
});

To learn more about Groups, refer to the of these docs.

Groups section
store.update()