Class Paper<UserOperations>

constructor

• new Paper<UserOperations>(graphqlSchema, options?): Paper<UserOperations>

• Type Parameters

  • UserOperations extends OperationMap = OperationMap

  Parameters

  • graphqlSchema: string | DocumentNode | GraphQLSchema
  • Optionaloptions: PaperConstructorOptions<UserOperations>

  Returns Paper<UserOperations>

events

hooks

operations

validators

data

• get data(): DocumentStore

• Returns DocumentStore

clear

• clear(): void

• Returns void

find

• find(documentOrKey): undefined | Document

• Parameters

  • documentOrKey: KeyOrDocument

  Returns undefined | Document

mutate

• mutate<T>(fn): ReturnType<T>

• Type Parameters

  • T extends TransactionCallback<operations & OperationMap & UserOperations>

  Parameters

  • fn: T

  Returns ReturnType<T>

serialize

• serialize(): SerializedPaper

• Returns SerializedPaper

Staticdeserialize

• deserialize<DeserializeUserOperations>(graphqlSchema, serializedPaper, options?): Paper<DeserializeUserOperations>

• Type Parameters

  • DeserializeUserOperations extends OperationMap = OperationMap

  Parameters

  • graphqlSchema: GraphQLSchema
  • serializedPaper: SerializedPaper
  • Optionaloptions: PaperConstructorOptions<DeserializeUserOperations>

  Returns Paper<DeserializeUserOperations>