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

@nerdware/ts-type-safety-utils

v1.0.15

Published

TypeScript type-guards and other type-safety utils to suit common use cases.

Downloads

102

Readme

TypeScript type-guards and other type-safety utils for any environment 🎉ESM ✅ CommonJS ✅ NodeJS ✅ browsers ✅

npm package Test Workflow CodeCov pre-commit semantic-release License: MIT

🚀 Getting Started

This package provides a lightweight set of TypeScript type-guards and other type-safety utils to suit common use cases.

📦 Installation

Install the package using your package manager of choice:

npm:

npm install @nerdware/ts-type-safety-utils

yarn:

yarn add @nerdware/ts-type-safety-utils

🛠️ Usage

import { isPlainObject } from "@nerdware/ts-type-safety-utils";

// or const { isPlainObject } = require("@nerdware/ts-type-safety-utils");

const fooFn = (input: unknown) => {
  if (isPlainObject(input)) {
    // TS knows `input` is a plain object
  } else {
    // TS knows `input` is not a plain object
  }
};

⚙️ API

Is-x type-guards

| Function | Description | | :---------------------------------------- | :------------------------------------------------------------------------------- | | isArray | Checks if a value is an array or readonly array | | isBigInt | Checks if a value is a BigInt | | isBoolean | Checks if a value is a boolean | | isBuffer | Checks if a value is a NodeJS Buffer (this is a no-op in browser envs) | | isDate | Checks if a value is a Date | | isError | Checks if a value is an Error, an Error subclass, or DOMException | | isFunction | Checks if a value is a function | | isNull | Checks if a value is null | | isObjectLike | Checks if a value is "object-like" (typeof "object" and not null) | | isPlainObject | Checks if a value is a plain object | | isSafeInteger | Checks if a value is a safe integer | | isString | Checks if a value is a string | | isSymbol | Checks if a value is a symbol | | isUndefined | Checks if a value is undefined | | isUnsafeNumber | Checks if a value is typeof "number" (🚨 allows NaN and other "number" values) |

Other type-guards

| Function | Description | | :---------------------------------------------- | :--------------------------------------------------------------------------------------------------- | | getTypeSafeError | Converts any argument into an Error object | | hasKey | Checks if an object contains the provided key | | hasKeys | Checks if an object contains all provided keys | | safeJsonStringify | Type-safe JSON.stringify which will not throw if the input contains circular references or BigInts |

🤝 Contributing

Pull requests are welcome! Before you begin, please check existing GitHub Issues and Pull Requests to see if your idea is already in the pipeline. If not, here's a guide on how to contribute to this project. Thank you!

📝 License

All files, scripts, and source code contained herein are open-source software licensed under an MIT License.

See LICENSE for more information.

💬 Contact

Trevor Anderson — [email protected]@TeeRevTweets

Dare Mighty Things.