• /
  • Log in
  • Free account

AccountStorageMutation

Usage

import { AccountStorageMutation } from 'nr1'

Examples

Props

accountIdrequirednumber

Account identifier.

actionTyperequiredenum

Type of action to perform.

<One of
AccountStorageMutation.ACTION_TYPE.DELETE_COLLECTION,
AccountStorageMutation.ACTION_TYPE.DELETE_DOCUMENT,
AccountStorageMutation.ACTION_TYPE.WRITE_DOCUMENT,
>
childrenrequiredfunction

Render prop function as children.

function (
mutate: function,

Function to trigger a mutation from your UI.

mutationResult: MutationResult

Results of the mutation.

) => React.ReactNode
collectionrequiredstring

Collection name.

documentobject

NerdStorage document. Documents are restricted to 64 kB in size when JSON-stringified.

documentIdstring

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.

) => PromiseQueryResult

Type 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.

}
Create issueEdit page
Copyright © 2021 New Relic Inc.