JSPM

  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 2224
  • Score
    100M100P100Q111382F
  • License MIT

Typescript definitions for HAL

Package Exports

  • hal-types

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (hal-types) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

Typescript types for HAL documents

This repository exports a set of typescript types for HAL documents.

It exports the following interfaces:

  1. HalLink, representing an individual HAL Link
  2. HalResource, representing a single HAL document, with at least a _links property and optionally an _embedded property.

In addition to the standard HAL Link properties such as href and title, it also has support for Link hints, as defined in draft-nottingham-link-hint.