GetEntityOrThrowOptions

Options used by the TransactionalConnection getEntityOrThrow method.

Signature

interface GetEntityOrThrowOptions<T = any> extends FindOneOptions<T> {    channelId?: ID;    retries?: number;    retryDelay?: number;    includeSoftDeleted?: boolean;}

Extends: FindOneOptions<T>

channelId

propertyID

An optional channelId to limit results to entities assigned to the given Channel. Should only be used when getting entities that implement the ChannelAware interface.

retries

propertynumberv1.1.0

Default:0

If set to a positive integer, it will retry getting the entity in case it is initially not found.

retryDelay

propertynumberv1.1.0

Default:25

Specifies the delay in ms to wait between retries.

includeSoftDeleted

propertybooleanv1.3.0

Default:false

If set to true, soft-deleted entities will be returned. Otherwise they will throw as if they did not exist.