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

    Type Alias Link

    Represents a hypermedia link in HAL format.

    Links are the foundation of HATEOAS navigation, connecting resources and enabling discovery of related resources and available actions.

    HAL Specification

    type Link = {
        anchor?: string;
        context: string;
        hints?: LinkHints;
        href: string;
        hreflang?: string;
        media?: string;
        name?: string;
        rel: string;
        templated?: boolean;
        title?: string;
        type?: string;
    }
    Index

    Properties

    anchor? context hints? href hreflang? media? name? rel templated? title? type?

    Properties

    anchor?: string

    Anchor for fragment-based links within a document.

    context: string

    Context URI for resolving relative hrefs.

    hints?: LinkHints

    Extended link hints per draft-nottingham-link-hint.

    href: string

    Target URI of the linked resource.

    May be a URI template if templated is true.

    hreflang?: string

    Language of the target resource.

    media?: string

    Media query hint for the target resource.

    name?: string

    Secondary identifier for the link.

    Used in HAL for distinguishing multiple links with the same rel.

    HAL name property

    rel: string

    Link relation type (e.g., 'self', 'next', 'author').

    IANA Link Relations

    templated?: boolean

    Indicates if href is a URI Template (RFC 6570).

    When true, use template variables to expand the URI.

    title?: string

    Human-readable link title.

    type?: string

    Expected content type of the target resource.

    Settings

    Member Visibility

    On This Page

    Properties