Class RecordGetOperation<T, OPTIONS>

Builder/executor for list and find operations against one layout.

Type Parameters

T extends LayoutInterface
OPTIONS extends GetOperationOptions<T>

Index

Constructors

constructor

new RecordGetOperation<
    T extends LayoutInterface,
    OPTIONS extends GetOperationOptions<T>,
>(
    layout: LayoutBase,
    options: OPTIONS,
): RecordGetOperation<T, OPTIONS>
Type Parameters
- T extends LayoutInterface
- OPTIONS extends GetOperationOptions<T>
Parameters
- layout: LayoutBase
- options: OPTIONS
Returns RecordGetOperation<T, OPTIONS>
- Defined in src/records/getOperations/recordGetOperation.ts:46

Properties

`Protected`layout

layout: LayoutBase

`Protected`limit

limit: number = 100

`Protected`offset

offset: number = 1

`Protected`portals

portals: Partial<PortalData<T>>

`Protected`requests

requests: { omit?: boolean; req: FindRequestRaw }[] = []

`Protected`scriptData

scriptData: ScriptRequestData = {}

`Protected`sortData

sortData: { fieldName: string; sortOrder: SortOrder }[] = []

Accessors

isFindRequest

get isFindRequest(): boolean
Returns boolean
- Defined in src/records/getOperations/recordGetOperation.ts:57

Methods

[asyncIterator]

"[asyncIterator]"(): {
    next: () => Promise<
        {
            done: boolean;
            value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>
            | undefined;
        },
    >;
    "[asyncIterator]"(): { next: () => Promise<{ done: boolean; value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>> | undefined; }>; [Symbol.asyncIterator](): ...; };
}
Returns {
    next: () => Promise<
        {
            done: boolean;
            value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>
            | undefined;
        },
    >;
    "[asyncIterator]"(): { next: () => Promise<{ done: boolean; value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>> | undefined; }>; [Symbol.asyncIterator](): ...; };
}
- Defined in src/records/getOperations/recordGetOperation.ts:282

addRequest

addRequest(query: FindRequest, omit?: boolean): RecordGetOperation<T, OPTIONS>
Add one FileMaker find request block.
Parameters
- query: FindRequest
  The find request to be added.
- Optionalomit: boolean = false
  Flag to indicate if the find request should be omitted.
Returns RecordGetOperation<T, OPTIONS>
- The current object instance.
- Defined in src/records/getOperations/recordGetOperation.ts:186

fetch

fetch(): Promise<LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>[]>
Execute request and return current page of records.

Returns Promise<LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>[]>
A promise that resolves with the result of the fetch operation.
- Defined in src/records/getOperations/recordGetOperation.ts:196

`Protected`generateParamsBody

generateParamsBody(offset: number, limit: number): Record<string, any>
Parameters
- offset: number
- limit: number
Returns Record<string, any>
- Defined in src/records/getOperations/recordGetOperation.ts:76

`Protected`generateParamsURL

generateParamsURL(offset: number, limit: number): URLSearchParams
Parameters
- offset: number
- limit: number
Returns URLSearchParams
- Defined in src/records/getOperations/recordGetOperation.ts:105

iterate

iterate(
    pageSize?: number,
): {
    next: () => Promise<
        {
            done: boolean;
            value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>
            | undefined;
        },
    >;
    "[asyncIterator]"(): { next: () => Promise<{ done: boolean; value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>> | undefined; }>; [Symbol.asyncIterator](): ...; };
}
Create async iterator that pages through results lazily.
Parameters
- pageSize: number = 100
  min: 1, max: 999
Returns {
    next: () => Promise<
        {
            done: boolean;
            value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>
            | undefined;
        },
    >;
    "[asyncIterator]"(): { next: () => Promise<{ done: boolean; value: LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>> | undefined; }>; [Symbol.asyncIterator](): ...; };
}
- Defined in src/records/getOperations/recordGetOperation.ts:240

scripts

scripts(scripts: ScriptRequestData): RecordGetOperation<T, OPTIONS>
Configures any FileMaker scripts to be run as a part of the request
Parameters
- scripts: ScriptRequestData
  The script request data to set.
Returns RecordGetOperation<T, OPTIONS>
- The current instance of the class.
- Defined in src/records/getOperations/recordGetOperation.ts:138

sort

sort(fieldName: string, sortOrder: SortOrder): RecordGetOperation<T, OPTIONS>
Add sort clause in request order.
Parameters
- fieldName: string
  The name of the field by which the data should be sorted.
- sortOrder: SortOrder
  The sort order to be applied (either "asc" for ascending or "desc" for descending).
Returns RecordGetOperation<T, OPTIONS>
- Returns the current instance of the object.
- Defined in src/records/getOperations/recordGetOperation.ts:151

Class RecordGetOperation<T, OPTIONS>

Type Parameters

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns RecordGetOperation<T, OPTIONS>

Properties

Protectedlayout

Protectedlimit

Protectedoffset

Protectedportals

Protectedrequests

ProtectedscriptData

ProtectedsortData

Accessors

isFindRequest

Returns boolean

Methods

[asyncIterator]

addRequest

Parameters

Returns RecordGetOperation<T, OPTIONS>

fetch

Returns Promise<LayoutRecord<PickPortals<T, keyof OPTIONS["portals"]>>[]>

ProtectedgenerateParamsBody

Parameters

Returns Record<string, any>

ProtectedgenerateParamsURL

Parameters

Returns URLSearchParams

iterate

Parameters

scripts

Parameters

Returns RecordGetOperation<T, OPTIONS>

sort

Parameters

Returns RecordGetOperation<T, OPTIONS>

Settings

On This Page

`Protected`layout

`Protected`limit

`Protected`offset

`Protected`portals

`Protected`requests

`Protected`scriptData

`Protected`sortData

`Protected`generateParamsBody

`Protected`generateParamsURL