@hateoas-ts/resource - v1.4.3
    Preparing search index...

    Type Alias HeadState<TEntity>

    Represents the metadata-only state of a resource from a HEAD response.

    HEAD state contains links and content headers, but no response body.

    type HeadState<TEntity extends Entity = Entity> = {
        links: Links<TEntity["links"]>;
        timestamp: number;
        uri: string;
        contentHeaders(): Headers;
        equalTo(state: State<any>): boolean;
        follow<K extends string | number | symbol>(
            rel: K,
            variables?: LinkVariables,
        ): Resource<TEntity["links"][K]>;
        followAll<K extends string | number | symbol>(
            rel: K,
        ): Resource<TEntity["links"][K]>[];
        getLink<K extends string | number | symbol>(rel: K): Link | undefined;
        hasLink<K extends string | number | symbol>(rel: K): boolean;
    }

    Type Parameters

    • TEntity extends Entity = Entity

      The entity type defining available links

    Index

    Properties

    links timestamp uri

    Methods

    contentHeaders equalTo follow followAll getLink hasLink

    Properties

    links: Links<TEntity["links"]>

    Raw links container for low-level traversal scenarios.

    timestamp: number

    Timestamp of when the head state was first generated

    uri: string

    The URI associated with this head state

    Methods

    • Checks if a link with the given relation exists.

      Type Parameters

      • K extends string | number | symbol

      Parameters

      • rel: K

      Returns boolean

    Settings

    Member Visibility

    On This Page

    Properties
    Methods