type-fest
Advanced tools
type-fest - npm Package Compare versions
Comparing version 0.16.0 to 0.17.0
@@ -27,2 +27,5 @@ // Basic | ||
| export {FixedLengthArray} from './source/fixed-length-array'; | ||
| export {IterableElement} from './source/iterable-element'; | ||
| export {Entry} from './source/entry'; | ||
| export {Entries} from './source/entries'; | ||
@@ -29,0 +32,0 @@ // Miscellaneous |
| { | ||
| "name": "type-fest", | ||
| "version": "0.16.0", | ||
| "version": "0.17.0", | ||
| "description": "A collection of essential TypeScript types", | ||
@@ -5,0 +5,0 @@ "license": "(MIT OR CC0-1.0)", |
@@ -86,2 +86,5 @@ <div align="center"> | ||
| - [`FixedLengthArray`](source/fixed-length-array.d.ts) - Create a type that represents an array of the given type and length. | ||
| - [`IterableElement`](source/iterable-element.d.ts) - Get the element type of an `Iterable`/`AsyncIterable`. For example, an array or a generator. | ||
| - [`Entry`](source/entry.d.ts) - Create a type that represents the type of an entry of a collection. | ||
| - [`Entries`](source/entries.d.ts) - Create a type that represents the type of the entries of a collection. | ||
@@ -88,0 +91,0 @@ ### Miscellaneous |
@@ -31,4 +31,4 @@ import {Primitive} from './basic'; | ||
| export type LiteralUnion< | ||
| LiteralType extends BaseType, | ||
| LiteralType, | ||
| BaseType extends Primitive | ||
| > = LiteralType | (BaseType & {_?: never}); |
@@ -340,190 +340,189 @@ import {LiteralUnion} from './literal-union'; | ||
| } | ||
| } | ||
| /** | ||
| Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file). Also includes types for fields used by other popular projects, like TypeScript and Yarn. | ||
| */ | ||
| export type PackageJson = { | ||
| /** | ||
| The name of the package. | ||
| Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file). Containing standard npm properties. | ||
| */ | ||
| name?: string; | ||
| export interface PackageJsonStandard { | ||
| /** | ||
| The name of the package. | ||
| */ | ||
| name?: string; | ||
| /** | ||
| Package version, parseable by [`node-semver`](https://github.com/npm/node-semver). | ||
| */ | ||
| version?: string; | ||
| /** | ||
| Package version, parseable by [`node-semver`](https://github.com/npm/node-semver). | ||
| */ | ||
| version?: string; | ||
| /** | ||
| Package description, listed in `npm search`. | ||
| */ | ||
| description?: string; | ||
| /** | ||
| Package description, listed in `npm search`. | ||
| */ | ||
| description?: string; | ||
| /** | ||
| Keywords associated with package, listed in `npm search`. | ||
| */ | ||
| keywords?: string[]; | ||
| /** | ||
| Keywords associated with package, listed in `npm search`. | ||
| */ | ||
| keywords?: string[]; | ||
| /** | ||
| The URL to the package's homepage. | ||
| */ | ||
| homepage?: LiteralUnion<'.', string>; | ||
| /** | ||
| The URL to the package's homepage. | ||
| */ | ||
| homepage?: LiteralUnion<'.', string>; | ||
| /** | ||
| The URL to the package's issue tracker and/or the email address to which issues should be reported. | ||
| */ | ||
| bugs?: PackageJson.BugsLocation; | ||
| /** | ||
| The URL to the package's issue tracker and/or the email address to which issues should be reported. | ||
| */ | ||
| bugs?: BugsLocation; | ||
| /** | ||
| The license for the package. | ||
| */ | ||
| license?: string; | ||
| /** | ||
| The license for the package. | ||
| */ | ||
| license?: string; | ||
| /** | ||
| The licenses for the package. | ||
| */ | ||
| licenses?: Array<{ | ||
| type?: string; | ||
| url?: string; | ||
| }>; | ||
| /** | ||
| The licenses for the package. | ||
| */ | ||
| licenses?: Array<{ | ||
| type?: string; | ||
| url?: string; | ||
| }>; | ||
| author?: PackageJson.Person; | ||
| author?: Person; | ||
| /** | ||
| A list of people who contributed to the package. | ||
| */ | ||
| contributors?: PackageJson.Person[]; | ||
| /** | ||
| A list of people who contributed to the package. | ||
| */ | ||
| contributors?: Person[]; | ||
| /** | ||
| A list of people who maintain the package. | ||
| */ | ||
| maintainers?: PackageJson.Person[]; | ||
| /** | ||
| A list of people who maintain the package. | ||
| */ | ||
| maintainers?: Person[]; | ||
| /** | ||
| The files included in the package. | ||
| */ | ||
| files?: string[]; | ||
| /** | ||
| The files included in the package. | ||
| */ | ||
| files?: string[]; | ||
| /** | ||
| Resolution algorithm for importing ".js" files from the package's scope. | ||
| /** | ||
| Resolution algorithm for importing ".js" files from the package's scope. | ||
| [Read more.](https://nodejs.org/api/esm.html#esm_package_json_type_field) | ||
| */ | ||
| type?: 'module' | 'commonjs'; | ||
| [Read more.](https://nodejs.org/api/esm.html#esm_package_json_type_field) | ||
| */ | ||
| type?: 'module' | 'commonjs'; | ||
| /** | ||
| The module ID that is the primary entry point to the program. | ||
| */ | ||
| main?: string; | ||
| /** | ||
| The module ID that is the primary entry point to the program. | ||
| */ | ||
| main?: string; | ||
| /** | ||
| Standard entry points of the package, with enhanced support for ECMAScript Modules. | ||
| /** | ||
| Standard entry points of the package, with enhanced support for ECMAScript Modules. | ||
| [Read more.](https://nodejs.org/api/esm.html#esm_package_entry_points) | ||
| */ | ||
| exports?: PackageJson.Exports; | ||
| [Read more.](https://nodejs.org/api/esm.html#esm_package_entry_points) | ||
| */ | ||
| exports?: Exports; | ||
| /** | ||
| The executable files that should be installed into the `PATH`. | ||
| */ | ||
| bin?: | ||
| | string | ||
| | { | ||
| [binary: string]: string; | ||
| }; | ||
| /** | ||
| The executable files that should be installed into the `PATH`. | ||
| */ | ||
| bin?: | ||
| | string | ||
| | { | ||
| [binary: string]: string; | ||
| }; | ||
| /** | ||
| Filenames to put in place for the `man` program to find. | ||
| */ | ||
| man?: string | string[]; | ||
| /** | ||
| Filenames to put in place for the `man` program to find. | ||
| */ | ||
| man?: string | string[]; | ||
| /** | ||
| Indicates the structure of the package. | ||
| */ | ||
| directories?: PackageJson.DirectoryLocations; | ||
| /** | ||
| Indicates the structure of the package. | ||
| */ | ||
| directories?: DirectoryLocations; | ||
| /** | ||
| Location for the code repository. | ||
| */ | ||
| repository?: | ||
| | string | ||
| | { | ||
| type: string; | ||
| url: string; | ||
| /** | ||
| Location for the code repository. | ||
| */ | ||
| repository?: | ||
| | string | ||
| | { | ||
| type: string; | ||
| url: string; | ||
| /** | ||
| Relative path to package.json if it is placed in non-root directory (for example if it is part of a monorepo). | ||
| [Read more.](https://github.com/npm/rfcs/blob/latest/implemented/0010-monorepo-subdirectory-declaration.md) | ||
| */ | ||
| directory?: string; | ||
| }; | ||
| /** | ||
| Relative path to package.json if it is placed in non-root directory (for example if it is part of a monorepo). | ||
| Script commands that are run at various times in the lifecycle of the package. The key is the lifecycle event, and the value is the command to run at that point. | ||
| */ | ||
| scripts?: Scripts; | ||
| [Read more.](https://github.com/npm/rfcs/blob/latest/implemented/0010-monorepo-subdirectory-declaration.md) | ||
| /** | ||
| Is used to set configuration parameters used in package scripts that persist across upgrades. | ||
| */ | ||
| directory?: string; | ||
| }; | ||
| config?: { | ||
| [configKey: string]: unknown; | ||
| }; | ||
| /** | ||
| Script commands that are run at various times in the lifecycle of the package. The key is the lifecycle event, and the value is the command to run at that point. | ||
| */ | ||
| scripts?: PackageJson.Scripts; | ||
| /** | ||
| The dependencies of the package. | ||
| */ | ||
| dependencies?: Dependency; | ||
| /** | ||
| Is used to set configuration parameters used in package scripts that persist across upgrades. | ||
| */ | ||
| config?: { | ||
| [configKey: string]: unknown; | ||
| }; | ||
| /** | ||
| Additional tooling dependencies that are not required for the package to work. Usually test, build, or documentation tooling. | ||
| */ | ||
| devDependencies?: Dependency; | ||
| /** | ||
| The dependencies of the package. | ||
| */ | ||
| dependencies?: PackageJson.Dependency; | ||
| /** | ||
| Dependencies that are skipped if they fail to install. | ||
| */ | ||
| optionalDependencies?: Dependency; | ||
| /** | ||
| Additional tooling dependencies that are not required for the package to work. Usually test, build, or documentation tooling. | ||
| */ | ||
| devDependencies?: PackageJson.Dependency; | ||
| /** | ||
| Dependencies that will usually be required by the package user directly or via another dependency. | ||
| */ | ||
| peerDependencies?: Dependency; | ||
| /** | ||
| Dependencies that are skipped if they fail to install. | ||
| */ | ||
| optionalDependencies?: PackageJson.Dependency; | ||
| /** | ||
| Dependencies that will usually be required by the package user directly or via another dependency. | ||
| */ | ||
| peerDependencies?: PackageJson.Dependency; | ||
| /** | ||
| Indicate peer dependencies that are optional. | ||
| */ | ||
| peerDependenciesMeta?: { | ||
| [packageName: string]: { | ||
| optional: true; | ||
| /** | ||
| Indicate peer dependencies that are optional. | ||
| */ | ||
| peerDependenciesMeta?: { | ||
| [packageName: string]: { | ||
| optional: true; | ||
| }; | ||
| }; | ||
| }; | ||
| /** | ||
| Package names that are bundled when the package is published. | ||
| */ | ||
| bundledDependencies?: string[]; | ||
| /** | ||
| Package names that are bundled when the package is published. | ||
| */ | ||
| bundledDependencies?: string[]; | ||
| /** | ||
| Alias of `bundledDependencies`. | ||
| */ | ||
| bundleDependencies?: string[]; | ||
| /** | ||
| Alias of `bundledDependencies`. | ||
| */ | ||
| bundleDependencies?: string[]; | ||
| /** | ||
| Engines that this package runs on. | ||
| */ | ||
| engines?: { | ||
| [EngineName in 'npm' | 'node' | string]: string; | ||
| }; | ||
| /** | ||
| Engines that this package runs on. | ||
| */ | ||
| engines?: { | ||
| [EngineName in 'npm' | 'node' | string]: string; | ||
| }; | ||
| /** | ||
| @deprecated | ||
| */ | ||
| engineStrict?: boolean; | ||
| /** | ||
| @deprecated | ||
| */ | ||
| engineStrict?: boolean; | ||
| /** | ||
| Operating systems the module runs on. | ||
| */ | ||
| os?: Array<LiteralUnion< | ||
| /** | ||
| Operating systems the module runs on. | ||
| */ | ||
| os?: Array<LiteralUnion< | ||
| | 'aix' | ||
@@ -544,8 +543,8 @@ | 'darwin' | ||
| string | ||
| >>; | ||
| >>; | ||
| /** | ||
| CPU architectures the module runs on. | ||
| */ | ||
| cpu?: Array<LiteralUnion< | ||
| /** | ||
| CPU architectures the module runs on. | ||
| */ | ||
| cpu?: Array<LiteralUnion< | ||
| | 'arm' | ||
@@ -574,33 +573,33 @@ | 'arm64' | ||
| string | ||
| >>; | ||
| >>; | ||
| /** | ||
| If set to `true`, a warning will be shown if package is installed locally. Useful if the package is primarily a command-line application that should be installed globally. | ||
| /** | ||
| If set to `true`, a warning will be shown if package is installed locally. Useful if the package is primarily a command-line application that should be installed globally. | ||
| @deprecated | ||
| */ | ||
| preferGlobal?: boolean; | ||
| @deprecated | ||
| */ | ||
| preferGlobal?: boolean; | ||
| /** | ||
| If set to `true`, then npm will refuse to publish it. | ||
| */ | ||
| private?: boolean; | ||
| /** | ||
| If set to `true`, then npm will refuse to publish it. | ||
| */ | ||
| private?: boolean; | ||
| /** | ||
| A set of config values that will be used at publish-time. It's especially handy to set the tag, registry or access, to ensure that a given package is not tagged with 'latest', published to the global public registry or that a scoped module is private by default. | ||
| */ | ||
| publishConfig?: { | ||
| [config: string]: unknown; | ||
| }; | ||
| /** | ||
| A set of config values that will be used at publish-time. It's especially handy to set the tag, registry or access, to ensure that a given package is not tagged with 'latest', published to the global public registry or that a scoped module is private by default. | ||
| */ | ||
| publishConfig?: { | ||
| [config: string]: unknown; | ||
| }; | ||
| /** | ||
| Describes and notifies consumers of a package's monetary support information. | ||
| /** | ||
| Describes and notifies consumers of a package's monetary support information. | ||
| [Read more.](https://github.com/npm/rfcs/blob/latest/accepted/0017-add-funding-support.md) | ||
| */ | ||
| funding?: string | { | ||
| /** | ||
| The type of funding. | ||
| [Read more.](https://github.com/npm/rfcs/blob/latest/accepted/0017-add-funding-support.md) | ||
| */ | ||
| type?: LiteralUnion< | ||
| funding?: string | { | ||
| /** | ||
| The type of funding. | ||
| */ | ||
| type?: LiteralUnion< | ||
| | 'github' | ||
@@ -613,14 +612,20 @@ | 'opencollective' | ||
| string | ||
| >; | ||
| /** | ||
| The URL to the funding page. | ||
| */ | ||
| url: string; | ||
| }; | ||
| } & | ||
| >; | ||
| /** | ||
| The URL to the funding page. | ||
| */ | ||
| url: string; | ||
| }; | ||
| } | ||
| } | ||
| /** | ||
| Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file). Also includes types for fields used by other popular projects, like TypeScript and Yarn. | ||
| */ | ||
| export type PackageJson = | ||
| PackageJson.PackageJsonStandard & | ||
| PackageJson.NonStandardEntryPoints & | ||
| PackageJson.TypeScriptConfiguration & | ||
| PackageJson.YarnConfiguration & | ||
| PackageJson.JSPMConfiguration & { | ||
| [key: string]: unknown; | ||
| }; | ||
| PackageJson.JSPMConfiguration; |
New alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Fixed alerts
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
Improved metrics
- Total package byte prevSize
- increased by7.88%
98671
- Number of package files
- increased by10.34%
32
- Lines of code
- increased by7.03%
2070
- Number of lines in readme file
- increased by0.47%
647
No dependency changes