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

eslint-plugin-redundant-undefined

v1.0.0

Published

ESlint rule for disallow redundant undefined

Downloads

101,622

Readme

eslint-plugin-redundant-undefined

Forbids optional parameters to include an explicit undefined in their type and requires to use undefined in optional properties.

GitHub license npm version GitHub Workflow Status (with branch) Coverage Status npm downloads

Installation

$ npm i eslint-plugin-redundant-undefined @typescript-eslint/parser --save-dev

Usage

Add redundant-undefined to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "parser": "@typescript-eslint/parser",
  "plugins": ["redundant-undefined"]
}

Then configure the rules you want to use under the rules section.

{
  "rules": {
    "redundant-undefined/redundant-undefined": "error"
  }
}

Rule Details

  • Avoid explicitly specifying undefined as a type for a parameter/property which is already optional

Options

  • followExactOptionalPropertyTypes - Requires explicitly specifying undefined as a type for a parameter which is already optional., this provides the correct semantics for people who have exactOptionalPropertyType: true

Examples

Examples of incorrect code:

function f(s?: undefined | string): void {}

function f(s?: number | undefined | string): void {}

interface I {
  a?: string | undefined;
}

class C {
  a?: string | undedined;
}

Examples of correct code:

function f(s?: string): void {}

interface I {
  a?: string;
}

interface I {
  a?: any;
}

class C {
  a?: string;
}

Examples of incorrect code for the { "followExactOptionalPropertyTypes": true }:

interface I {
  p?: string;
}

class C {
  private p?: number;
}

abstract class C {
  abstract p?: string;
}

Examples of correct code for the { "followExactOptionalPropertyTypes": true }:

interface I {
  p?: string | undefined;
}

interface I {
  p?: any;
}

class C {
  private p?: number | undefined;
}

abstract class C {
  abstract p?: string | undefined;
}

License and Copyright

This software is released under the terms of the MIT license.