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

option-types

v1.1.0

Published

Utility types for options

Downloads

166

Readme

option-types

Utility types for options-related TypeScript definitions.

This package doesn't have any runtime code. It only contains types.

Motivation

Using exactOptionalPropertyTypes in TypeScript is great, except when you have a big object type with many optional properties. Manually adding undefined to every optional property type is annoying and error-prone.

Using conditional types and mapped types, we can automatically add undefined to every optional property type.

Types

Option<T>

Any type wrapped in Option can be assigned an undefined value. If the wrapped type is an object, its optional properties can also be assigned an undefined value. This type is recursive.

Options<T>

When an object type is itself required, but it contains optional properties, this type can be used to ensure that the optional properties can be assigned an undefined value. This type is recursive, so nested object types are also affected.

OptionalKeys<T>

Extract the keys of an object type that are optional. Note that a key is only considered “optional” if it was defined with a ? in the type definition.

ShallowOptions<T>

Ensure each optional property can be assigned an undefined value. Nested object types are not affected.