Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
// Will use any port from 3000 to 3100, otherwise fall back to a random port
})();
```
## API
### getPort([options])
Returns a `Promise` for a port number.
#### options
Type: `Object`
##### port
Type: `number | Iterable<number>`
A preferred port or an iterable of preferred ports to use.
##### host
Type: `string`
The host on which port resolution should be performed. Can be either an IPv4 or IPv6 address.
### getPort.makeRange(from, to)
Make a range of ports `from`...`to`.
Returns an `Iterable` for ports in the given range.
#### from
Type: `number`
First port of the range. Must be in the range `1024`...`65535`.
#### to
Type: `number`
Last port of the range. Must be in the range `1024`...`65535` and must be greater than `from`.
## Beware
There is a very tiny chance of a race condition if another service starts using the same port number as you in between the time you get the port number and you actually start using it.
## Related
-[get-port-cli](https://github.com/sindresorhus/get-port-cli) - CLI for this module
**2019-03-12** - 5th birthday of systeminformation. This is amazing. Started as a small projekt just for myself, it now has > 8,000 lines of code, > 200 versions published, up to 100,000 downloads per month, > 1 Mio downloads overall. Thank you to all who contributed to this project!
This is amazing. Started as a small project just for myself, it now has > 9,000 lines of code, > 250 versions published, up to 400,000 downloads per month, > 1 Mio downloads overall. Thank you to all who contributed to this project!
Matches any [typed array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray), like `Uint8Array` or `Float64Array`.
Matches a value that is like an [Observable](https://github.com/tc39/proposal-observable).
*/
exportinterfaceObservableLike{
subscribe(observer:(value:unknown)=>void):void;
[Symbol.observable]():ObservableLike;
}
/**
Create a type from an object type without certain keys.
@example
```
import {Omit} from 'type-fest';
type Foo = {
a: number;
b: string;
};
type FooWithoutA = Omit<Foo, 'a'>;
//=> {b: string};
```
I'm surprised this one is not built-in. It seems [other people agree](https://github.com/Microsoft/TypeScript/issues/12215#issuecomment-420919470). Please 👍 [this issue on TypeScript](https://github.com/Microsoft/TypeScript/issues/30455) about making it built-in.
Create a type that has mutually exclusive properties.
This type was inspired by [this comment](https://github.com/Microsoft/TypeScript/issues/14094#issuecomment-373782604).
This type works with a helper type, called `Without`. `Without<FirstType, SecondType>` produces a type that has only keys from `FirstType` which are not present on `SecondType` and sets the value type for these keys to `never`. This helper type is then used in `MergeExclusive` to remove keys from either `FirstType` or `SecondType`.
@example
```
import {MergeExclusive} from 'type-fest';
interface ExclusiveVariation1 {
exclusive1: boolean;
}
interface ExclusiveVariation2 {
exclusive2: string;
}
type ExclusiveOptions = MergeExclusive<ExclusiveVariation1, ExclusiveVariation2>;
Allows creating a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union.
Currently, when a union type of a primitive type is combined with literal types, TypeScript loses all information about the combined literals. Thus, when such type is used in an IDE with autocompletion, no suggestions are made for the declared literals.
This type is a workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729). It will be removed as soon as it's not needed anymore.
@example
```
import {LiteralUnion} from 'type-fest';
// Before
type Pet = 'dog' | 'cat' | string;
const pet: Pet = '';
// Start typing in your TypeScript-enabled IDE.
// You **will not** get auto-completion for `dog` and `cat` literals.
// After
type Pet2 = LiteralUnion<'dog' | 'cat', string>;
const pet: Pet2 = '';
// You **will** get auto-completion for `dog` and `cat` literals.
```
*/
exporttypeLiteralUnion<
LiteralTypeextendsBaseType,
BaseTypeextendsPrimitive
>=LiteralType|(BaseType&{_?:never});
/*
Create a type that requires at least one of the given properties. The remaining properties are kept as is.
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
Many of the types here should have been built-in. You can help by suggesting some of them to the [TypeScript project](https://github.com/Microsoft/TypeScript/blob/master/CONTRIBUTING.md).
Either add this package as a dependency or copy-paste the needed types. No credit required. 👌
PR welcome for additional commonly needed types and docs improvements. Read the [contributing guidelines](.github/contributing.md) first.
## Install
```
$ npm install type-fest
```
## Usage
```ts
import{Omit}from'type-fest';
typeFoo={
unicorn:string;
rainbow:boolean;
};
typeFooWithoutRainbow=Omit<Foo,'rainbow'>;
//=> {unicorn: string}
```
## API
See the [types file](index.d.ts) for complete docs.
### Basic
-`Primitive` - Matches any [primitive value](https://developer.mozilla.org/en-US/docs/Glossary/Primitive).
-`Class` - Matches a [`class` constructor](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Classes).
-`TypedArray` - Matches any [typed array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/TypedArray), like `Uint8Array` or `Float64Array`.
-`JsonObject` - Matches a JSON object.
-`JsonArray` - Matches a JSON array.
-`JsonValue` - Matches any valid JSON value.
-`ObservableLike` - Matches a value that is like an [Observable](https://github.com/tc39/proposal-observable).
### Utilities
-`Omit` - Create a type from an object type without certain keys.
-`Merge` - Merge two types into a new type. Keys of the second type overrides keys of the first type.
-`MergeExclusive` - Create a type that has mutually exclusive properties.
-`RequireAtLeastOne` - Create a type that requires at least one of the given properties.
-`LiteralUnion` - Allows creating a union type by combining primitive types and literal types without sacrificing auto-completion in IDEs for the literal type part of the union. Workaround for [Microsoft/TypeScript#29729](https://github.com/Microsoft/TypeScript/issues/29729).
### Miscellaneous
-`PackageJson` - Type for [npm's `package.json` file](https://docs.npmjs.com/creating-a-package-json-file).
## Declined types
*If we decline a type addition, we will make sure to document the better solution here.*
## Tips
### Built-in types
There are many advanced types most users don't know about.
-[`Partial<T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1401-L1406) - Make all properties in `T` optional.
-[`Required<T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1408-L1413) - Make all properties in `T` required.
-[`Readonly<T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1415-L1420) - Make all properties in `T` readonly.
-[`Pick<T, K>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1422-L1427) - From `T`, pick a set of properties whose keys are in the union `K`.
-[`Record<K, T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1429-L1434) - Construct a type with a set of properties `K` of type `T`.
-[`Exclude<T, U>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1436-L1439) - Exclude from `T` those types that are assignable to `U`.
-[`Extract<T, U>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1441-L1444) - Extract from `T` those types that are assignable to `U`.
-[`NonNullable<T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1446-L1449) - Exclude `null` and `undefined` from `T`.
-[`Parameters<T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1451-L1454) - Obtain the parameters of a function type in a tuple.
-[`ConstructorParameters<T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1456-L1459) - Obtain the parameters of a constructor function type in a tuple.
-[`ReturnType<T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1461-L1464) – Obtain the return type of a function type.
-[`InstanceType<T>`](https://github.com/Microsoft/TypeScript/blob/2961bc3fc0ea1117d4e53bc8e97fa76119bc33e3/src/lib/es5.d.ts#L1466-L1469) – Obtain the instance type of a constructor function type.
You can find some examples in the [TypeScript docs](https://www.typescriptlang.org/docs/handbook/advanced-types.html#predefined-conditional-types).
A person who has been involved in creating or maintaining the package.
*/
exporttypePerson=
|string
|{
name:string;
url?:string;
email?:string;
};
exporttypeBugsLocation=
|string
|{
/**
The URL to the package's issue tracker.
*/
url?:string;
/**
The email address to which issues should be reported.
*/
email?:string;
};
exportinterfaceDirectoryLocations{
/**
Location for executable scripts. Sugar to generate entries in the `bin` property by walking the folder.
*/
bin?:string;
/**
Location for Markdown files.
*/
doc?:string;
/**
Location for example scripts.
*/
example?:string;
/**
Location for the bulk of the library.
*/
lib?:string;
/**
Location for man pages. Sugar to generate a `man` array by walking the folder.
*/
man?:string;
/**
Location for test files.
*/
test?:string;
[directoryType:string]:unknown;
}
exporttypeScripts={
/**
Run **before** the package is published (Also run on local `npm install` without any arguments).
*/
prepublish?:string;
/**
Run both **before** the package is packed and published, and on local `npm install` without any arguments. This is run **after** `prepublish`, but **before** `prepublishOnly`.
*/
prepare?:string;
/**
Run **before** the package is prepared and packed, **only** on `npm publish`.
*/
prepublishOnly?:string;
/**
Run **before** a tarball is packed (on `npm pack`, `npm publish`, and when installing git dependencies).
*/
prepack?:string;
/**
Run **after** the tarball has been generated and moved to its final destination.
*/
postpack?:string;
/**
Run **after** the package is published.
*/
publish?:string;
/**
Run **after** the package is published.
*/
postpublish?:string;
/**
Run **before** the package is installed.
*/
preinstall?:string;
/**
Run **after** the package is installed.
*/
install?:string;
/**
Run **after** the package is installed and after `install`.
*/
postinstall?:string;
/**
Run **before** the package is uninstalled and before `uninstall`.
*/
preuninstall?:string;
/**
Run **before** the package is uninstalled.
*/
uninstall?:string;
/**
Run **after** the package is uninstalled.
*/
postuninstall?:string;
/**
Run **before** bump the package version and before `version`.
*/
preversion?:string;
/**
Run **before** bump the package version.
*/
version?:string;
/**
Run **after** bump the package version.
*/
postversion?:string;
/**
Run with the `npm test` command, before `test`.
*/
pretest?:string;
/**
Run with the `npm test` command.
*/
test?:string;
/**
Run with the `npm test` command, after `test`.
*/
posttest?:string;
/**
Run with the `npm stop` command, before `stop`.
*/
prestop?:string;
/**
Run with the `npm stop` command.
*/
stop?:string;
/**
Run with the `npm stop` command, after `stop`.
*/
poststop?:string;
/**
Run with the `npm start` command, before `start`.
*/
prestart?:string;
/**
Run with the `npm start` command.
*/
start?:string;
/**
Run with the `npm start` command, after `start`.
*/
poststart?:string;
/**
Run with the `npm restart` command, before `restart`. Note: `npm restart` will run the `stop` and `start` scripts if no `restart` script is provided.
*/
prerestart?:string;
/**
Run with the `npm restart` command. Note: `npm restart` will run the `stop` and `start` scripts if no `restart` script is provided.
*/
restart?:string;
/**
Run with the `npm restart` command, after `restart`. Note: `npm restart` will run the `stop` and `start` scripts if no `restart` script is provided.
*/
postrestart?:string;
}&{
[scriptName:string]:string;
}
/**
Dependencies of the package. The version range is a string which has one or more space-separated descriptors. Dependencies can also be identified with a tarball or Git URL.
*/
exportinterfaceDependency{
[packageName:string]:string;
}
exportinterfaceNonStandardEntryPoints{
/**
An ECMAScript module ID that is the primary entry point to the program.
*/
module?:string;
/**
A module ID with untranspiled code that is the primary entry point to the program.
*/
esnext?:
|string
|{
main?:string;
browser?:string;
[moduleName:string]:string|undefined;
};
/**
A hint to JavaScript bundlers or component tools when packaging modules for client side use.
*/
browser?:
|string
|{
[moduleName:string]:string|false;
};
}
exportinterfaceTypeScriptConfiguration{
/**
Location of the bundled TypeScript declaration file.
*/
types?:string;
/**
Location of the bundled TypeScript declaration file. Alias of `types`.
*/
typings?:string;
}
exportinterfaceYarnConfiguration{
/**
Selective version resolutions. Allows the definition of custom package versions inside dependencies without manual edits in the `yarn.lock` file.
*/
resolutions?:Dependency;
}
exportinterfaceJSPMConfiguration{
/**
JSPM configuration.
*/
jspm?:PackageJson;
}
}
/**
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.
*/
exporttypePackageJson={
/**
The name of the package.
*/
name?:string;
/**
Package version, parseable by [`node-semver`](https://github.com/npm/node-semver).
*/
version?:string;
/**
Package description, listed in `npm search`.
*/
description?: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 issue tracker and/or the email address to which issues should be reported.
*/
bugs?:PackageJson.BugsLocation;
/**
The license for the package.
*/
license?:string;
/**
The licenses for the package.
*/
licenses?:{
type?:string;
url?:string;
}[];
author?:PackageJson.Person;
/**
A list of people who contributed to the package.
*/
contributors?:PackageJson.Person[];
/**
A list of people who maintain the package.
*/
maintainers?:PackageJson.Person[];
/**
The files included in the package.
*/
files?:string[];
/**
The module ID that is the primary entry point to the program.
*/
main?: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[];
/**
Indicates the structure of the package.
*/
directories?:PackageJson.DirectoryLocations;
/**
Location for the code repository.
*/
repository?:
|string
|{
type:string;
url:string;
};
/**
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;
/**
Is used to set configuration parameters used in package scripts that persist across upgrades.
*/
config?:{
[configKey:string]:unknown;
};
/**
The dependencies of the package.
*/
dependencies?:PackageJson.Dependency;
/**
Additional tooling dependencies that are not required for the package to work. Usually test, build, or documentation tooling.
*/
devDependencies?:PackageJson.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;
/**
Package names that are bundled when the package is published.
*/
bundledDependencies?:string[];
/**
Alias of `bundledDependencies`.
*/
bundleDependencies?:string[];
/**
Engines that this package runs on.
*/
engines?:{
[EngineNamein'npm'|'node'|string]:string;
};
/**
@deprecated
*/
engineStrict?:boolean;
/**
Operating systems the module runs on.
*/
os?:LiteralUnion<
|'aix'
|'darwin'
|'freebsd'
|'linux'
|'openbsd'
|'sunos'
|'win32'
|'!aix'
|'!darwin'
|'!freebsd'
|'!linux'
|'!openbsd'
|'!sunos'
|'!win32',
string
>[];
/**
CPU architectures the module runs on.
*/
cpu?:LiteralUnion<
|'arm'
|'arm64'
|'ia32'
|'mips'
|'mipsel'
|'ppc'
|'ppc64'
|'s390'
|'s390x'
|'x32'
|'x64'
|'!arm'
|'!arm64'
|'!ia32'
|'!mips'
|'!mipsel'
|'!ppc'
|'!ppc64'
|'!s390'
|'!s390x'
|'!x32'
|'!x64',
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.
@deprecated
*/
preferGlobal?: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.
All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
* async middleware was called twice ([#1422](https://github.com/yargs/yargs/issues/1422)) ([9a42b63](https://github.com/yargs/yargs/commit/9a42b63))
* fix promise check to accept any spec conform object ([#1424](https://github.com/yargs/yargs/issues/1424)) ([0be43d2](https://github.com/yargs/yargs/commit/0be43d2))
* groups were not being maintained for nested commands ([#1430](https://github.com/yargs/yargs/issues/1430)) ([d38650e](https://github.com/yargs/yargs/commit/d38650e))
***docs:** broken markdown link ([#1426](https://github.com/yargs/yargs/issues/1426)) ([236e24e](https://github.com/yargs/yargs/commit/236e24e))
* support merging deeply nested configuration ([#1423](https://github.com/yargs/yargs/issues/1423)) ([bae66fe](https://github.com/yargs/yargs/commit/bae66fe))
### Features
***deps:** introduce yargs-parser with support for unknown-options-as-args ([#1440](https://github.com/yargs/yargs/issues/1440)) ([4d21520](https://github.com/yargs/yargs/commit/4d21520))
* detect zsh when zsh isnt run as a login prompt ([#1395](https://github.com/yargs/yargs/issues/1395)) ([8792d13](https://github.com/yargs/yargs/commit/8792d13))
* populate correct value on yargs.parsed and stop warning on access ([#1412](https://github.com/yargs/yargs/issues/1412)) ([bb0eb52](https://github.com/yargs/yargs/commit/bb0eb52))
* showCompletionScript was logging script twice ([#1388](https://github.com/yargs/yargs/issues/1388)) ([07c8537](https://github.com/yargs/yargs/commit/07c8537))
* strict() should not ignore hyphenated arguments ([#1414](https://github.com/yargs/yargs/issues/1414)) ([b774b5e](https://github.com/yargs/yargs/commit/b774b5e))
***docs:** formalize existing callback argument to showHelp ([#1386](https://github.com/yargs/yargs/issues/1386)) ([d217764](https://github.com/yargs/yargs/commit/d217764))
### Features
* make it possible to merge configurations when extending other config. ([#1411](https://github.com/yargs/yargs/issues/1411)) ([5d7ad98](https://github.com/yargs/yargs/commit/5d7ad98))
