Parsing

A requirement for any API client is parsing content from a server response. For a Siren client, we can use the parse function to transform content to an instance of an Entity.

We can use it to parse JSON text:

import { Entity, parse } from '@siren-js/client';

const siren = JSON.stringify(orderEntity); // orderEntity is from the Modeling page 👉
const sameAsOrderEntity = await parse(siren);

// specify the type of entity's `properties` using `parse`'s type parameter
const orderWithTypedProperties = await parse<OrderProperties>(siren);

We can also parse a plain object:

const obj = JSON.parse(siren);
const theSameOrderEntity = await parse(obj);

We can even parse a Response object with Siren content:

const response = await fetch('http://api.x.io/orders/42');
const alsoTheOrderEntity = await parse(response);

As a Siren API client, you’ll primarily be using this approach to parsing after following a link or submitting an action.