Class LookupInSpec

Represents a sub-operation to perform within a lookup-in operation.

Hierarchy

  • LookupInSpec

Accessors

Methods

Accessors

  • get Expiry(): LookupInMacro
  • BUG(JSCBC-756): Previously provided access to the expiry macro for a lookup-in operation.

    Returns LookupInMacro

    Deprecated

    Use Expiry instead.

Methods

  • Returns the number of elements in the array reference by the path.

    Parameters

    • path: string | LookupInMacro

      The path to the field.

    • Optional options: {
          xattr?: boolean;
      }

      Optional parameters for this operation.

      • Optional xattr?: boolean

        Whether this operation should reference the document body or the extended attributes data for the document.

    Returns LookupInSpec

  • Returns whether a specific field exists in the document.

    Parameters

    • path: string | LookupInMacro

      The path to the field.

    • Optional options: {
          xattr?: boolean;
      }

      Optional parameters for this operation.

      • Optional xattr?: boolean

        Whether this operation should reference the document body or the extended attributes data for the document.

    Returns LookupInSpec

  • Creates a LookupInSpec for fetching a field from the document.

    Parameters

    • path: string | LookupInMacro

      The path to the field.

    • Optional options: {
          xattr?: boolean;
      }

      Optional parameters for this operation.

      • Optional xattr?: boolean

        Whether this operation should reference the document body or the extended attributes data for the document.

    Returns LookupInSpec

Generated using TypeDoc