npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@dialexa/pleco-joi

v0.2.2

Published

# Pleco Joi

Downloads

12

Readme

Pleco logo

Pleco Joi

Table of Contents

Overview

The Joi validation schemas provide additional protection around what the user inputs.

Joi Validation Schemas

Provided Exports

filterQuerySchema: a function that returns the schema pertaining to the IFilterQuery typescript type or the FilterQuery_* GraphQL type.

The rules for filters are:

  • each filter query can contain nested AND or OR
  • each filter object can have multiple operators
  • each filter can only have the keys specified in the schema
  • the filter can be empty

Usage

import { filterQuerySchema } from '@dialexa/pleco-joi';
import Joi from 'joi';

const vehicleFilterSchema = Joi.object().keys({
  AND: Joi.array().items(Joi.lazy(() => vehicleFilterSchema)),
  OR: Joi.array().items(Joi.lazy(() => vehicleFilterSchema)),
  make: filterQuerySchema('String', Joi.string()),
  model: filterQuerySchema('String', Joi.string()),
  // We can define any Joi schema
  numberOfUsers: filterQuerySchema('Int', Joi.number().integer().min(0)),
  highwayMPG: filterQuerySchema('Int', Joi.number().integer().min(0)),
  cityMPG: filterQuerySchema('Int', Joi.number().integer().min(0)),
  userSurveyRating: filterQUerySchema('Float', Joi.number().min(0).max(100)),
});

sortDirectionSchema: validates that the argument to a sort operation is 'ASC' or 'DESC' (case insensitive). Validating against this schema will also automatically convert the input to uppercase.

Usage

import { sortDirectionSchema } from '@dialexa/pleco-joi';
import Joi from 'joi';

const vehicleSortSchemaKeys = {
  numberOfUsers: sortDirectionSchema,
  userSurveyRating: sortDirectionSchema,
};

const vehicleSortSchema = Joi.object().keys(vehicleSortSchemaKeys).oxor(Object.keys(vehicleSortSchemaKeys));

limitOffsetPageSchema: validates that an object containing optional limit and offset are non-negative integers

Resources