Save, delete, or update an account scoped document in NerdStorage. In order to successfully perform this operation, the user must have the right permissions.
Usage
import { AccountStorageMutation } from 'nr1'Examples
Write document
AccountStorageMutation.mutate({ accountId: 1, actionType: AccountStorageMutation.ACTION_TYPE.WRITE_DOCUMENT, collection: 'myCollection', documentId: 'myDocumentId', document: { name: 'John', surname: 'Doe', },});Delete document
AccountStorageMutation.mutate({ accountId: 1, actionType: AccountStorageMutation.ACTION_TYPE.DELETE_DOCUMENT, collection: 'myCollection', documentId: 'myDocumentId',});Delete collection
AccountStorageMutation.mutate({ accountId: 1, actionType: AccountStorageMutation.ACTION_TYPE.DELETE_COLLECTION, collection: 'myCollection',});Props
REQUIREDnumber | Account identifier. |
REQUIREDenum | Type of action to perform. <One of |
REQUIREDfunction | Render prop function as children. function ( |
REQUIREDstring | Collection name. |
object | NerdStorage document. Documents are restricted to 64 kB in size when JSON-stringified. |
string | Document identifier to operate in. When omitted the whole collection is returned. |
Methods
AccountStorageMutation.mutate
function (props: Object Object containing the mutation options. Any AccountStorageMutation prop is a valid option except children.
) => PromiseQueryResultType definitions
PromiseQueryResult
{error: ApolloClient.ApolloError, Runtime error with graphQLErrors and networkError properties.
data: Object, Object containing the result of your query.
fetchMore: function|null, If not null, fetchMore allows you to load more results for your query. New data is merged with previous data.
refetch: function, Refetch the query.
}MutationResult
{loading: boolean, Indicates that the request is in flight.
error: ApolloClient.ApolloError, Runtime error with graphQLErrors and networkError properties.
data: Object, Object containing the result of your mutation.
}