getInstancesChunk MethodProtected

Used by clients to get a chunk of strongly typed instances from standard WSG REST queries that return EC JSON instances.

getInstancesChunk<T extends WsgInstance<T>>(requestContext: AuthorizedClientRequestContext, url: string, chunkedQueryContext: undefined | ChunkedQueryContext, typedConstructor: () => T, queryOptions?: RequestQueryOptions, httpRequestOptions?: HttpRequestOptions): Promise<T[]>

Parameter Type Description
requestContext AuthorizedClientRequestContext Client request context
url string Full path to the REST resource.
chunkedQueryContext undefined | ChunkedQueryContext Chunked query context.
typedConstructor () => T Constructor function for the type
queryOptions RequestQueryOptions Query options.
httpRequestOptions HttpRequestOptions Additional options for the HTTP request.

Returns - Promise<T[]>

Array of strongly typed instances.

Defined in

Last Updated: 12 June, 2024