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

primitive-parser

v1.1.2

Published

Master your input data like a pro!

Downloads

5

Readme

This is an image

Simple helper library which allows you to ensure the integrity and type safety of your app's input data.

It works by exposing a number of functions which check wether an unknown value is either a string, boolean, float, integer or object. You can also turn strings into numbers or booleans.

:rocket: Getting started

npm

$ npm i primitive-parser

yarn

$ yarn add primitive-parser

:bulb: Examples

🕵 Make sure nasty user inputs do not reach your app.

// ...

import express from 'express'
import { getPositiveInteger } from 'primitive-parser'

// ...

app.get('/:user/:id', function (req, res) {
  const id = getPositiveInteger(req.params.id)
  if (!id) {
    return res.status(400)
  }

  // At this point, "id" is infered as "number".
  showUser(req, res, id)
})

// ...

🧛 Unsure about external events? No more.

import { getObject, getString } from 'primitive-parser'
import { useState } from 'react'
import SketchyInput from 'unknown-source'

const SafeInput = () => {
  const [value, setValue] = useState<string>('')

  const onValueChange = (sketchyEvent: any) => {
    const safeValue = getString(getObject(sketchyEvent)?.value)

    // Important over "!safeValue" since the latter returns "false" on valid empty strings.
    if (safeValue !== undefined) {
      // "safeValue" is inferred as "string" inside this block scope.
      setValue(safeValue)
    } else {
      // Error handling
    }
  }

  return <SketchyInput onValueChange={onValueChange} value={value} />
}

:beer: Full helper list

Check out the tests file for a full behavioural overview.

String

const getString = (value: unknown): string | undefined
getString('foo') // "foo"
getObject({ foo: 'bar' }) // undefined

Boolean

const getBoolean = (value: unknown): boolean | undefined
getBoolean('true') // undefined
getBoolean(true) // true

Boolean from String

const getBooleanFromString = (value: unknown): boolean | undefined
getBoolean('true') // true
getBoolean(true) // undefined

Float

const getFloat = (value: unknown): number | undefined
getFloat('12.34') // undefined
getFloat(12.34) // 12.34

Float from String

const getFloatFromString = (value: unknown): number | undefined
getFloat('12.34') // 12.34
getFloat(Infinity) // undefined
getFloat(12.34) // undefined

Integer

const getInteger = (value: unknown): number | undefined
getInteger('1234') // undefined
getInteger(12.34) // undefined
getFloat(1234) // 1234

Integer from string

const getIntegerFromString = (value: unknown): number | undefined
getIntegerFromString('1234') // 1234
getIntegerFromString(1234)) // undefined
getIntegerFromString(12.34) // undefined

Positive Integer

const getPositiveInteger = (value: unknown): number | undefined
getPositiveInteger('1') // undefined
getPositiveInteger(0) // undefined
getPositiveInteger(-1) // undefined
getPositiveInteger(1) // 1

Positive Integer from String

const getPositiveInteger = (value: unknown): number | undefined
getPositiveInteger('1') // undefined
getPositiveInteger(1) // 1
getPositiveInteger(-1) // undefined

Object (general)

const getObject = (value: unknown): object | undefined
getObject('foo')) // undefined
getObject({ foo: 'bar' }) // { foo: "bar" }