API referenceInterfaces

RestPaginationOptions

Generated API reference for RestPaginationOptions in @kysoql/rest.

@kysoql/rest / RestPaginationOptions

Safety limits applied while following Salesforce query pagination.

Properties

Property	Modifier	Type	Description
`batchSize?`	`readonly`	`number`	Requested batch size (200-2000), not a guaranteed page size.
`maxPages?`	`readonly`	`number`	Query-page budget across root and relationship continuations. Default: 10,000.
`maxRecords?`	`readonly`	`number`	Optional root-record budget. Exceeding it throws, never silently truncates.

RestGetOptions

Generated API reference for RestGetOptions in @kysoql/rest.

RestQueryOptions

Generated API reference for RestQueryOptions in @kysoql/rest.