Class LookupInSpec

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

Hierarchy

LookupInSpec

Index

Accessors

Expiry

Methods

Accessors

Static Expiry

get Expiry(): LookupInMacro

- Defined in lib/sdspecs.ts:132
BUG(JSCBC-756): Previously provided access to the expiry macro for a lookup-in operation.

deprecated
Use LookupInMacro.Expiry instead.

Returns LookupInMacro

Methods

Static count

count(path: string | LookupInMacro, options?: { xattr?: boolean }): LookupInSpec

- Defined in lib/sdspecs.ts:228
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

Static exists

exists(path: string | LookupInMacro, options?: { xattr?: boolean }): LookupInSpec

- Defined in lib/sdspecs.ts:212
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

Static get

get(path: string | LookupInMacro, options?: { xattr?: boolean }): LookupInSpec

- Defined in lib/sdspecs.ts:193
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