Class VmSelect

Construct data for selecting (querying) data from a VoidMerge instance.

Index

Constructors

Properties

filterByIdents? filterByShorts? filterByTypes? returnData? returnIdent? returnShort? returnType?

Methods

encode withFilterByIdents withFilterByShorts withFilterByTypes withReturnData withReturnIdent withReturnShort withReturnType

Constructors

constructor

new VmSelect(): VmSelect
Returns VmSelect

Properties

`Optional`filterByIdents

filterByIdents?: VmHash[]

`Optional`filterByShorts

filterByShorts?: VmHash[]

`Optional`filterByTypes

filterByTypes?: string[]

`Optional`returnData

returnData?: boolean

`Optional`returnIdent

returnIdent?: boolean

`Optional`returnShort

returnShort?: boolean

`Optional`returnType

returnType?: boolean

Methods

encode

encode(): Uint8Array
Returns Uint8Array
- Defined in types.ts:882

withFilterByIdents

withFilterByIdents(idents: VmHash[]): VmSelect
If you would like to only return items with specific idents, specify that list of idents here.
Parameters
- idents: VmHash[]
Returns VmSelect
- Defined in types.ts:943

withFilterByShorts

withFilterByShorts(shorts: VmHash[]): VmSelect
Parameters
- shorts: VmHash[]
Returns VmSelect
- Defined in types.ts:950

withFilterByTypes

withFilterByTypes(types: string[]): VmSelect
By default, select will return items of all types. If you would like to limit this, specify a list of types to include.
Parameters
- types: string[]
Returns VmSelect
- Defined in types.ts:934

withReturnData

withReturnData(returnData: boolean): VmSelect
By default, select results do not include the actualy data content. If you set returnData to true, this will be included in the result. Note that this may result in a very large response that may get truncated. Instead, you could fetch a list of short hashes, and then make separate individual requests for the content data.
Parameters
- returnData: boolean
Returns VmSelect
- Defined in types.ts:989

withReturnIdent

withReturnIdent(returnIdent: boolean): VmSelect
By default, select results do not include the ident. If you set returnIdent to true, these idents will be included.
Parameters
- returnIdent: boolean
Returns VmSelect
- Defined in types.ts:968

withReturnShort

withReturnShort(returnShort: boolean): VmSelect
By default, select results do not include the short hash. If you set returnShort to true, these hashes will be included.
Parameters
- returnShort: boolean
Returns VmSelect
- Defined in types.ts:959

withReturnType

withReturnType(returnType: boolean): VmSelect
By default, select results do not include the type of the item. If you set returnType to true, the type will be included with the items.
Parameters
- returnType: boolean
Returns VmSelect
- Defined in types.ts:977