Générer des types Sarcastic à partir de JSON — Numio

Quand l’utiliser

• Vérifier à l’exécution la forme du JSON récupéré dans un petit projet JavaScript sans bibliothèque de schémas.
• Protéger des payloads de configuration ou de messages avec des assertions qui lèvent une erreur sur des données inattendues.

Mode d’emploi

1. Collez un objet JSON ; pour marquer des champs comme optionnels, incluez des éléments de tableau avec et sans eux.
2. Lisez la sortie : la forme racine est RootInterface, les formes imbriquées prennent le nom de leur clé (posts devient Posts).
3. Copiez le code et validez les données avec is(data, RootInterface), qui renvoie la valeur ou lève une erreur en cas de non-correspondance.

{
  "id": 1,
  "name": "Ada",
  "nickname": null,
  "tags": ["math"],
  "posts": [
    { "title": "Notes", "draft": true },
    { "title": "Engine" }
  ]
}

import is from "sarcastic"

const anyValue = (value) => value

const Posts = is.shape({
  title: is.string,
  draft: is.maybe(is.boolean),
})

const RootInterface = is.shape({
  id: is.number,
  name: is.string,
  nickname: is.maybe(anyValue),
  tags: is.arrayOf(is.string),
  posts: is.arrayOf(Posts),
})

Détails et limites

Généré dans le navigateur par le générateur propre au site, avec ajout de import is from "sarcastic" et formatage Prettier ; aucune requête au serveur.

sarcastic n’a pas d’assertion « any » : une valeur toujours null devient donc is.maybe(anyValue), grâce à un petit helper const anyValue = (value) => value ajouté à la sortie.

Les entiers comme les décimaux sont is.number. Les tableaux vides deviennent is.array ; les tableaux mixtes utilisent is.either, comme is.arrayOf(is.either(is.number, is.string)).

Les formes sont déclarées avant celles qui les utilisent : le code fonctionne donc tel qu’il est collé.

FAQ

Outils associés

Spécifications et références

• sarcastic on GitHub