Tipi Sarcastic da JSON — Numio

Quando usarlo

• Controllo della forma del JSON recuperato in fase di esecuzione in un piccolo progetto JavaScript senza una libreria di schemi.
• Proteggere i payload di configurazione o di messaggi con asserzioni che generano dati imprevisti.

Come si usa

1. Incolla un oggetto JSON; per contrassegnare i campi come facoltativi, includere elementi dell'array con e senza di essi.
2. Leggi l'output: la forma della radice è RootInterface, le forme nidificate prendono il nome dalle loro chiavi (i post diventano Post).
3. Copia il codice e convalida i dati con is(data, RootInterface), che restituisce il valore o genera una mancata corrispondenza.

{
  "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),
})

Dettagli e limiti

Generato nel browser dal generatore del sito, con l’aggiunta di import is from "sarcastic" e formattazione Prettier; non vengono fatte richieste a un server.

sarcastic non ha un’asserzione "any", quindi un valore che è soltanto null diventa is.maybe(anyValue), usando la piccola funzione ausiliaria const anyValue = (value) => value aggiunta all’output.

Sia gli interi che i decimali sono is.number. Gli array vuoti diventano is.array; gli array misti utilizzano is.either, ad esempio is.arrayOf(is.either(is.number, is.string)).

Le forme vengono dichiarate prima delle forme che le utilizzano, quindi il codice viene eseguito come incollato.

FAQ

Strumenti correlati

Specifiche e riferimenti

• sarcastico su GitHub