Skip to content

Class: ReadSuccess\<ResourceType>

Indicates that the request to read a resource was a success

Type parameters

Name Type
ResourceType extends Resource

Hierarchy

↳ ReadSuccess

↳↳ AbsentReadSuccess

Constructors

constructor

• new ReadSuccess\<ResourceType>(resource, recalledFromMemory): ReadSuccess\<ResourceType>

Type parameters

Name Type
ResourceType extends Resource\<string>

Parameters

Name Type
resource ResourceType
recalledFromMemory boolean

Returns

ReadSuccess\<ResourceType>

Overrides

ResourceSuccess.constructor

Defined in

packages/connected/src/results/success/ReadSuccess.ts:16

Properties

isError

• Readonly isError: false

Inherited from

ResourceSuccess.isError

Defined in

packages/connected/src/results/success/SuccessResult.ts:9


recalledFromMemory

• recalledFromMemory: boolean

True if the resource was recalled from local memory rather than a recent request

Defined in

packages/connected/src/results/success/ReadSuccess.ts:14


resource

• resource: ResourceType

The resource that was successful

Inherited from

ResourceSuccess.resource

Defined in

packages/connected/src/results/success/SuccessResult.ts:25


type

• Readonly Abstract type: string

Inherited from

ResourceSuccess.type

Defined in

packages/connected/src/results/success/SuccessResult.ts:8


uri

• uri: ResourceType["uri"]

The URI of the resource

Inherited from

ResourceSuccess.uri

Defined in

packages/connected/src/results/success/SuccessResult.ts:21