Class OperationStack

constructor

• new OperationStack(
      stack?: TOperationStackOptionsInit,
      project?: ProxyNodeExtended,
  ): OperationStack

• Parameters

  • Optionalstack: TOperationStackOptionsInit
  • Optionalproject: ProxyNodeExtended

  Returns OperationStack

operations

Optionalroot

addOperation

• get addOperation(): <T extends IOperation>(
      operation: T,
  ) => {
      _id?: string;
      data?: Record<string, any>;
      delta?: Record<string, any>;
      eventTime?: number;
      method?: "POST" | "UPDATE" | "DELETE";
      operationId?: string;
      operationType?:
          | "node"
          | "structure"
          | "structure-child"
          | "relation"
          | "metadata"
          | "list"
          | "list-child";
      ref?: any;
  }

• The add(operation:IOperation):void; function is a method of the IOperationStack interface. It is used to add an operation to the stack of operations. The operation parameter is of type IOperation, which represents an operation that can be performed on a data structure. The function does not return anything (void).

  Returns <T extends IOperation>(
      operation: T,
  ) => {
      _id?: string;
      data?: Record<string, any>;
      delta?: Record<string, any>;
      eventTime?: number;
      method?: "POST" | "UPDATE" | "DELETE";
      operationId?: string;
      operationType?:
          | "node"
          | "structure"
          | "structure-child"
          | "relation"
          | "metadata"
          | "list"
          | "list-child";
      ref?: any;
  }

deleteOperation

• get deleteOperation(): (operationId: string) => boolean

• The delete(operationId):void; function is a method of the IOperationStack interface. It is used to remove an operation from the stack of operations based on its ID. The operationId parameter is the ID of the operation to be deleted. The function does not return anything (void).

  Returns (operationId: string) => boolean

getOperation

• get getOperation(): (
      operationId: string,
  ) => {
      _id?: string;
      data?: Record<string, any>;
      delta?: Record<string, any>;
      eventTime?: number;
      method?: "POST" | "UPDATE" | "DELETE";
      operationId?: string;
      operationType?:
          | "node"
          | "structure"
          | "structure-child"
          | "relation"
          | "metadata"
          | "list"
          | "list-child";
      ref?: any;
  }

• The get(operationId):void; function is a method of the IOperationStack interface. It is used to retrieve an operation from the stack of operations based on its ID. The operationId parameter is the ID of the operation to be retrieved. The function does not return anything (void).

  Returns (
      operationId: string,
  ) => {
      _id?: string;
      data?: Record<string, any>;
      delta?: Record<string, any>;
      eventTime?: number;
      method?: "POST" | "UPDATE" | "DELETE";
      operationId?: string;
      operationType?:
          | "node"
          | "structure"
          | "structure-child"
          | "relation"
          | "metadata"
          | "list"
          | "list-child";
      ref?: any;
  }

jsonReady

• get jsonReady(): {
      _id?: string;
      data: Record<string, any>;
      delta?: Record<string, any>;
      eventTime?: number;
      method?: "POST" | "UPDATE" | "DELETE";
      operationId?: string;
      operationType?:
          | "node"
          | "structure"
          | "structure-child"
          | "relation"
          | "metadata"
          | "list"
          | "list-child";
      ref?: any;
  }[]

• The function returns an array of values from a Map object.

  Returns {
      _id?: string;
      data: Record<string, any>;
      delta?: Record<string, any>;
      eventTime?: number;
      method?: "POST" | "UPDATE" | "DELETE";
      operationId?: string;
      operationType?:
          | "node"
          | "structure"
          | "structure-child"
          | "relation"
          | "metadata"
          | "list"
          | "list-child";
      ref?: any;
  }[]

  An array containing the values of the operations map.

updateOperation

• get updateOperation(): (
      operation: {
          _id?: string;
          data?: Record<string, any>;
          delta?: Record<string, any>;
          eventTime?: number;
          method?: "POST" | "UPDATE" | "DELETE";
          operationId?: string;
          operationType?:
              | "node"
              | "structure"
              | "structure-child"
              | "relation"
              | "metadata"
              | "list"
              | "list-child";
          ref?: any;
      },
  ) => Map<
      string,
      {
          _id?: string;
          data?: Record<string, any>;
          delta?: Record<string, any>;
          eventTime?: number;
          method?: "POST" | "UPDATE" | "DELETE";
          operationId?: string;
          operationType?:
              | "node"
              | "structure"
              | "structure-child"
              | "relation"
              | "metadata"
              | "list"
              | "list-child";
          ref?: any;
      },
  >

• The update(operationId):void; function is a method of the IOperationStack interface. It is used to update an operation in the stack of operations based on its ID. The operationId parameter is the ID of the operation to be updated. The function does not return anything (void).

  Returns (
      operation: {
          _id?: string;
          data?: Record<string, any>;
          delta?: Record<string, any>;
          eventTime?: number;
          method?: "POST" | "UPDATE" | "DELETE";
          operationId?: string;
          operationType?:
              | "node"
              | "structure"
              | "structure-child"
              | "relation"
              | "metadata"
              | "list"
              | "list-child";
          ref?: any;
      },
  ) => Map<
      string,
      {
          _id?: string;
          data?: Record<string, any>;
          delta?: Record<string, any>;
          eventTime?: number;
          method?: "POST" | "UPDATE" | "DELETE";
          operationId?: string;
          operationType?:
              | "node"
              | "structure"
              | "structure-child"
              | "relation"
              | "metadata"
              | "list"
              | "list-child";
          ref?: any;
      },
  >

compareStack

• compareStack(
      stackToCompare: Map<
          string,
          {
              _id?: string;
              data?: Record<string, any>;
              delta?: Record<string, any>;
              eventTime?: number;
              method?: "POST" | "UPDATE" | "DELETE";
              operationId?: string;
              operationType?:
                  | "node"
                  | "structure"
                  | "structure-child"
                  | "relation"
                  | "metadata"
                  | "list"
                  | "list-child";
              ref?: any;
          },
      >,
  ): {
      _id?: string;
      data?: Record<string, any>;
      delta?: Record<string, any>;
      eventTime?: number;
      method?: "POST" | "UPDATE" | "DELETE";
      operationId?: string;
      operationType?:
          | "node"
          | "structure"
          | "structure-child"
          | "relation"
          | "metadata"
          | "list"
          | "list-child";
      ref?: any;
  }[]

• Parameters

  • stackToCompare: Map<
        string,
        {
            _id?: string;
            data?: Record<string, any>;
            delta?: Record<string, any>;
            eventTime?: number;
            method?: "POST" | "UPDATE" | "DELETE";
            operationId?: string;
            operationType?:
                | "node"
                | "structure"
                | "structure-child"
                | "relation"
                | "metadata"
                | "list"
                | "list-child";
            ref?: any;
        },
    >

  Returns {
      _id?: string;
      data?: Record<string, any>;
      delta?: Record<string, any>;
      eventTime?: number;
      method?: "POST" | "UPDATE" | "DELETE";
      operationId?: string;
      operationType?:
          | "node"
          | "structure"
          | "structure-child"
          | "relation"
          | "metadata"
          | "list"
          | "list-child";
      ref?: any;
  }[]

getTransactions

• getTransactions(): any[]

• The above code is defining a function called getTransactions in TypeScript. This function retrieves transactions from a collection of operations.

  Returns any[]

queryAllOperations

• queryAllOperations(query: any): any[]

• The above code is defining a function called queryAllOperations in TypeScript. This function takes a query parameter and returns an array of operations that match the query.

  Parameters

  • query: any

  Returns any[]