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

@sounisi5011/ts-type-util-has-own-property

v1.0.3

Published

Fix the type definition of the `Object.prototype.hasOwnProperty()` method

Downloads

5

Readme

@sounisi5011/ts-type-util-has-own-property

Go to the latest release page on npm

Fix the type definition of the Object.prototype.hasOwnProperty() method.

Installation

npm install @sounisi5011/ts-type-util-has-own-property
yarn add @sounisi5011/ts-type-util-has-own-property
pnpm add @sounisi5011/ts-type-util-has-own-property

Usage

import { hasOwnProperty } from '@sounisi5011/ts-type-util-has-own-property';

const hasOwnProp = Object.prototype.hasOwnProperty.call as hasOwnProperty;

if (hasOwnProp(object, 'propertyName')) {
    // `object.propertyName` is available!
}

if ((Object.prototype.hasOwnProperty.call as hasOwnProperty)(object, 'propertyName')) {
    // `object.propertyName` is available!
}

Optional property

If an object has an optional property, it should not contain the type undefined. The hasOwnProperty type removes the undef type that is implicitly added from the value of an optional property.

import { hasOwnProperty } from '@sounisi5011/ts-type-util-has-own-property';

const hasOwnProp = Object.prototype.hasOwnProperty.call as hasOwnProperty;

// ----- //

interface Obj {
    prop?: string;
}

const obj: Obj = {};

if (hasOwnProp(obj, 'prop')) {
    // `obj.prop` is `string` type.
    // Not `string | undefined` type!
}

Optional property for union types with undefined

Since TypeScript 4.4, when the exactOptionalPropertyTypes option is enabled, optional properties are no longer union types by default. In this case, it is possible to specify the union type with undefined type as an optional property. The hasOwnProperty type will not remove the undefined type of a union type whose undefined type has been explicitly specified.

import { hasOwnProperty } from '@sounisi5011/ts-type-util-has-own-property';

const hasOwnProp = Object.prototype.hasOwnProperty.call as hasOwnProperty;

// ----- //

interface Obj {
    prop?: string | undefined;
}

const obj: Obj = {};

if (hasOwnProp(obj, 'prop')) {
    // If the `exactOptionalPropertyTypes` option is true, `obj.prop` is `string | undefined` type.
    // If the `exactOptionalPropertyTypes` option is false, `obj.prop` is `string` type.
}

Union type property with undefined

If it is not an optional property, the undefined type should not be removed. The hasOwnProperty type properly distinguishes between optional properties and the union types of other properties.

import { hasOwnProperty } from '@sounisi5011/ts-type-util-has-own-property';

const hasOwnProp = Object.prototype.hasOwnProperty.call as hasOwnProperty;

// ----- //

interface Obj {
    prop: string | undefined;
}

const obj: Obj = { prop: undefined };

if (hasOwnProp(obj, 'prop')) {
    // `obj.prop` is `string | undefined` type.
    // Not `string` type!
}

Non-existent property

We sometimes want to check for the existence of properties whose types are not defined. The hasOwnProperty type assumes that the value of a non-existent property is of type unknown.

import { hasOwnProperty } from '@sounisi5011/ts-type-util-has-own-property';

const hasOwnProp = Object.prototype.hasOwnProperty.call as hasOwnProperty;

// ----- //

const obj = {};

if (hasOwnProp(obj, 'hoge')) {
    // `obj.hoge` is `unknown` type.
}