hal-types

Typescript definitions for HAL

Usage no npm install needed!

<script type="module">
  import halTypes from 'https://cdn.skypack.dev/hal-types';
</script>

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 _embedded property and _templates properties.
  3. LinkHints, an extension to links, as defined in draft-nottingham-link-hint.
  4. HalFormsTemplate, A HAL Forms template object.
  5. HalFormsProperty A single property from a HAL Form.