Class Paper<UserOperations>

constructor

• new Paper<UserOperations extends OperationMap = OperationMap>(
      graphqlSchema: string | DocumentNode | GraphQLSchema,
      options?: PaperConstructorOptions<UserOperations>,
  ): 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: KeyOrDocument): Document | undefined

  Parameters

  • documentOrKey: KeyOrDocument

  Returns Document | undefined

mutate

• mutate<
      T extends
          TransactionCallback<operations & OperationMap & UserOperations>,
  >(
      fn: T,
  ): ReturnType<T>

  Type Parameters

  • T extends TransactionCallback<operations & OperationMap & UserOperations>

  Parameters

  • fn: T

  Returns ReturnType<T>

serialize

• serialize(): SerializedPaper

  Returns SerializedPaper

Staticdeserialize

• deserialize<DeserializeUserOperations extends OperationMap = OperationMap>(
      graphqlSchema: GraphQLSchema,
      serializedPaper: SerializedPaper,
      options?: PaperConstructorOptions<DeserializeUserOperations>,
  ): Paper<DeserializeUserOperations>

  Type Parameters

  • DeserializeUserOperations extends OperationMap = OperationMap

  Parameters

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

  Returns Paper<DeserializeUserOperations>