@loaders.gl/schema

What is @loaders.gl/schema?

@loaders.gl/schema is a library that provides utilities for working with data schemas, including parsing, validation, and transformation of structured data. It is part of the larger loaders.gl suite, which is designed for loading and processing large datasets efficiently.

What are @loaders.gl/schema's main functionalities?

Schema Parsing

This feature allows you to define and parse a schema for structured data. The code sample demonstrates how to create a new schema with fields for 'id', 'name', and 'age'.

const { Schema } = require('@loaders.gl/schema');
const schema = new Schema({
  fields: [
    {name: 'id', type: 'integer'},
    {name: 'name', type: 'string'},
    {name: 'age', type: 'integer'}
  ]
});
console.log(schema);

Data Validation

This feature allows you to validate data against a defined schema. The code sample shows how to validate an object with 'id', 'name', and 'age' fields against the schema.

const { Schema, validate } = require('@loaders.gl/schema');
const schema = new Schema({
  fields: [
    {name: 'id', type: 'integer'},
    {name: 'name', type: 'string'},
    {name: 'age', type: 'integer'}
  ]
});
const data = { id: 1, name: 'John Doe', age: 30 };
const isValid = validate(schema, data);
console.log(isValid);

Data Transformation

This feature allows you to transform data to match the types defined in the schema. The code sample demonstrates transforming string values to their respective types as defined in the schema.

const { Schema, transform } = require('@loaders.gl/schema');
const schema = new Schema({
  fields: [
    {name: 'id', type: 'integer'},
    {name: 'name', type: 'string'},
    {name: 'age', type: 'integer'}
  ]
});
const data = { id: '1', name: 'John Doe', age: '30' };
const transformedData = transform(schema, data);
console.log(transformedData);

Other packages similar to @loaders.gl/schema

ajv

AJV (Another JSON Schema Validator) is a popular JSON schema validator that provides fast and flexible validation of JSON data. It supports JSON Schema draft-07 and is highly configurable. Compared to @loaders.gl/schema, AJV is more focused on JSON schema validation and offers extensive features for this purpose.

joi

Joi is a powerful schema description language and data validator for JavaScript. It allows you to create blueprints for JavaScript objects to ensure validation. Joi is more focused on validation and schema description, whereas @loaders.gl/schema also includes data transformation capabilities.

yup

Yup is a JavaScript schema builder for value parsing and validation. It is similar to Joi but is often used in React applications for form validation. Yup provides a more modern API and is highly flexible. Compared to @loaders.gl/schema, Yup is more focused on form validation and schema building.

README

@loaders.gl/schema

This module contains:

• Classes and APIs for manipulating tabular data output from loaders.gl table category loaders (CSV, JSON, ...).

loaders.gl is a collection of framework-independent 3D and geospatial parsers and encoders.

Please visit the website.

Changelog

v4.3.0-alpha.1

• fix(tile-converter): failing i3s-server (#2980)
• chore: Standardize tileIndex zoom->z (#2976)
• chore(mvt): loader and source cleanup (#2975)
• feat(parquet): support 'limit' option (#2973)
• chore(mvt): Deduplicate vector tile code (#2974)
• feat(mvt): TableTileSource (#2969)
• chore(mvt): refactor for clarity (#2971)
• docs: v4.2 release notes (#2963)

v4.2