Class ResourceRelation<TEntity>

Represents a deferred resource relationship for chained HATEOAS navigation.

ResourceRelation enables lazy, chainable navigation through HATEOAS links without immediately fetching intermediate resources. This is useful for building navigation paths that can be executed as a single operation.

// Navigate through multiple links
const comments = await client.go<User>('/users/123')
  .follow('posts')
  .follow('items')
  .follow('comments')
  .get();

// With template variables at each step
const result = await resource
  .follow('search', { q: 'hello' })
  .follow('items')
  .get();

See

Resource for direct resource operations
Resource.follow for creating ResourceRelation instances

Type Parameters

TEntity extends Entity
The entity type of the target resource

Index

Methods

delete follow followAll get getResource patch post postFollow preferTransclude preFetch put useHead

Methods

delete

delete(): Promise<State<TEntity>>
Deletes the target resource.

Resolves all intermediate relationships and performs DELETE on the target.

Returns Promise<State<TEntity>>
A Promise resolving to the response state

Throws
Throws HttpError When any request in the chain fails
- Defined in packages/resource/src/lib/resource/resource-relation.ts:240

follow

follow<K extends string | number | symbol>(
rel: K,
variables?: LinkVariables,
): ResourceRelation<TEntity["links"][K]>
Follows a resource relationship based on its rel type
Type Parameters
- K extends string | number | symbol
Parameters
- rel: K
  The relationship type, must be a key defined in the entity links
- Optionalvariables: LinkVariables
  the template variables
Returns ResourceRelation<TEntity["links"][K]>
Returns a new ResourceRelation instance representing the followed relationship
- Defined in packages/resource/src/lib/resource/resource-relation.ts:134

followAll

followAll<K extends string | number | symbol>(
rel: K,
): Promise<Resource<TEntity["links"][K]>[]>
Resolves all resources matching a relation from the target state.
Type Parameters
- K extends string | number | symbol
Parameters
- rel: K
Returns Promise<Resource<TEntity["links"][K]>[]>
- Defined in packages/resource/src/lib/resource/resource-relation.ts:152

get

get(requestOptions?: GetRequestOptions): Promise<State<TEntity>>
Fetches the target resource state.

Resolves all intermediate relationships and performs GET on the target.
Parameters
- OptionalrequestOptions: GetRequestOptions
  Optional request configuration
Returns Promise<State<TEntity>>
A Promise resolving to the target resource state

Throws
Throws HttpError When any request in the chain fails
- Defined in packages/resource/src/lib/resource/resource-relation.ts:168

getResource

getResource(): Promise<Resource<TEntity>>
Gets the resource instance

Returns Promise<Resource<TEntity>>
Returns a Promise of the resource instance
- Defined in packages/resource/src/lib/resource/resource-relation.ts:85

patch

patch(requestOptions: PatchRequestOptions): Promise<State<TEntity>>
Sends a PATCH request to the target resource.

Resolves all intermediate relationships and performs PATCH on the target. Defaults to application/json content-type.
Parameters
- requestOptions: PatchRequestOptions
  Request options including data payload and headers
Returns Promise<State<TEntity>>
A Promise resolving to the updated resource state

Throws
Throws HttpError When any request in the chain fails
- Defined in packages/resource/src/lib/resource/resource-relation.ts:183

post

post(
options: PostRequestOptions,
postOptions?: { dedup?: boolean },
): Promise<State>
Sends a POST request to the target resource.

Resolves all intermediate relationships and performs POST on the target. Supports request deduplication via postOptions.dedup.
Parameters
- options: PostRequestOptions
  Request options including data payload and headers
- OptionalpostOptions: { dedup?: boolean }
  Additional options (e.g., dedup: true)
Returns Promise<State>
A Promise resolving to the response state

Throws
Throws HttpError When any request in the chain fails
- Defined in packages/resource/src/lib/resource/resource-relation.ts:199

postFollow

postFollow<
    TFollowed extends
        Entity<any, Record<string, any>> = Entity<any, Record<string, any>>,
>(
    options: PostRequestOptions,
): Promise<Resource<TFollowed>>
Sends POST and follows the next resource according to response semantics.
Type Parameters
- TFollowed extends Entity<any, Record<string, any>> = Entity<any, Record<string, any>>
Parameters
- options: PostRequestOptions
Returns Promise<Resource<TFollowed>>
- Defined in packages/resource/src/lib/resource/resource-relation.ts:210

preferTransclude

preferTransclude(): ResourceRelation<TEntity>
Enables Prefer transclude hint when resolving links via GET.

Returns ResourceRelation<TEntity>
- Defined in packages/resource/src/lib/resource/resource-relation.ts:105

preFetch

preFetch(): ResourceRelation<TEntity>
Enables prefetching of the terminal linked resource state.

Returns ResourceRelation<TEntity>
- Defined in packages/resource/src/lib/resource/resource-relation.ts:92

put

put(requestOptions: PutRequestOptions): Promise<State<TEntity>>
Sends a PUT request to the target resource.

Resolves all intermediate relationships and performs PUT on the target. Defaults to application/json content-type.
Parameters
- requestOptions: PutRequestOptions
  Request options including complete data payload
Returns Promise<State<TEntity>>
A Promise resolving to the replaced resource state

Throws
Throws HttpError When any request in the chain fails
- Defined in packages/resource/src/lib/resource/resource-relation.ts:227

useHead

useHead(): ResourceRelation<TEntity>
Uses HEAD requests for link discovery on each hop.

Returns ResourceRelation<TEntity>
- Defined in packages/resource/src/lib/resource/resource-relation.ts:118

Class ResourceRelation<TEntity>

Example: Chained navigation

See

Type Parameters

Index

Methods

Methods

delete

Returns Promise<State<TEntity>>

Throws

follow

Type Parameters

Parameters

Returns ResourceRelation<TEntity["links"][K]>

followAll

Type Parameters

Parameters

Returns Promise<Resource<TEntity["links"][K]>[]>

get

Parameters

Returns Promise<State<TEntity>>

Throws

getResource

Returns Promise<Resource<TEntity>>

patch

Parameters

Returns Promise<State<TEntity>>

Throws

post

Parameters

Returns Promise<State>

Throws

postFollow

Type Parameters

Parameters

Returns Promise<Resource<TFollowed>>

preferTransclude

Returns ResourceRelation<TEntity>

preFetch

Returns ResourceRelation<TEntity>

put

Parameters

Returns Promise<State<TEntity>>

Throws

useHead

Returns ResourceRelation<TEntity>

Settings

On This Page