@sapphire/shapeshift

What is @sapphire/shapeshift?

@sapphire/shapeshift is a powerful validation library for JavaScript and TypeScript. It allows developers to define schemas for their data and validate it against these schemas. The library is designed to be highly flexible and easy to use, making it suitable for a wide range of applications.

What are @sapphire/shapeshift's main functionalities?

Basic Validation

This feature allows you to define a schema and validate an object against it. In this example, the schema expects an object with a 'name' string and an 'age' number.

const { s } = require('@sapphire/shapeshift');

const schema = s.object({
  name: s.string,
  age: s.number
});

const data = { name: 'John', age: 30 };
const result = schema.parse(data);
console.log(result); // { name: 'John', age: 30 }

Optional Fields

This feature allows you to define optional fields in your schema. In this example, the 'age' field is optional.

const { s } = require('@sapphire/shapeshift');

const schema = s.object({
  name: s.string,
  age: s.number.optional
});

const data = { name: 'John' };
const result = schema.parse(data);
console.log(result); // { name: 'John' }

Array Validation

This feature allows you to validate arrays. In this example, the schema expects an array of strings.

const { s } = require('@sapphire/shapeshift');

const schema = s.array(s.string);

const data = ['apple', 'banana', 'cherry'];
const result = schema.parse(data);
console.log(result); // ['apple', 'banana', 'cherry']

Nested Objects

This feature allows you to validate nested objects. In this example, the schema expects an object with a 'user' object that contains 'name' and 'age' fields.

const { s } = require('@sapphire/shapeshift');

const schema = s.object({
  user: s.object({
    name: s.string,
    age: s.number
  })
});

const data = { user: { name: 'John', age: 30 } };
const result = schema.parse(data);
console.log(result); // { user: { name: 'John', age: 30 } }

Other packages similar to @sapphire/shapeshift

joi

Joi is a powerful schema description language and data validator for JavaScript. It allows you to create blueprints or schemas for JavaScript objects to ensure validation of key information. Compared to @sapphire/shapeshift, Joi is more established and widely used in the industry, offering a rich set of features and integrations.

yup

Yup is a JavaScript schema builder for value parsing and validation. It is heavily inspired by Joi but is designed to work with modern JavaScript and TypeScript. Yup is known for its simplicity and ease of use, making it a popular choice for form validation in React applications. Compared to @sapphire/shapeshift, Yup offers a more modern API and better TypeScript support.

zod

Zod is a TypeScript-first schema declaration and validation library. It aims to provide a simple and expressive way to define schemas and validate data. Zod is particularly well-suited for TypeScript projects, offering excellent type inference and integration. Compared to @sapphire/shapeshift, Zod provides a more TypeScript-centric approach and better type safety.

README

The README file is missing