Skip to content

RequestOptions

Type@tryyoursize/node

Options of one call: the last argument of every method.

interface RequestOptions
idempotencyKeystring | undefinedOptional

Idempotency-Key for this POST (default: a random UUID, reused across this call's retries).

timeoutMsnumber | undefinedOptional

Overrides the client's timeout for this call.

maxRetriesnumber | undefinedOptional

Overrides the client's maxRetries for this call.

apiVersionstring | undefinedOptional

Overrides the client's TYS-Version for this call.

headersRecord<string, string> | undefinedOptional

Extra request headers.

signalAbortSignal | undefinedOptional

Aborts the call (not retried).

await tys.orders.create(order, { idempotencyKey: `order-${order.id}`, timeoutMs: 10_000 });

Was this page helpful?