Class LookupInSpec

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

Hierarchy

LookupInSpec

Index

Accessors

Methods

count exists get

Accessors

`Static` Expiry

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

Deprecated
Use Expiry instead.

Returns LookupInMacro
- Defined in lib/sdspecs.ts:128

Methods

`Static` count

count(path: string | LookupInMacro, options?: { xattr?: boolean }): LookupInSpec
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
- Defined in lib/sdspecs.ts:226

`Static` exists

exists(path: string | LookupInMacro, options?: { xattr?: boolean }): 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
- Defined in lib/sdspecs.ts:210

`Static` get

get(path: string | LookupInMacro, options?: { xattr?: boolean }): 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
- Defined in lib/sdspecs.ts:191

Generated using TypeDoc