mirror of
https://github.com/sindresorhus/type-fest.git
synced 2026-02-01 15:59:43 +00:00
Improve some descriptions
This commit is contained in:
parent
7698140bda
commit
7e7b5f7010
24
readme.md
24
readme.md
@ -169,8 +169,8 @@ Click the type names for complete docs.
|
||||
- [`IntClosedRange`](source/int-closed-range.d.ts) - Generate a union of numbers (includes the start and the end).
|
||||
- [`ArrayIndices`](source/array-indices.d.ts) - Provides valid indices for a constant array or tuple.
|
||||
- [`ArrayValues`](source/array-values.d.ts) - Provides all values for a constant array or tuple.
|
||||
- [`ArraySplice`](source/array-splice.d.ts) - Creates a new array type by adding or removing elements at a specified index range in the original array.
|
||||
- [`ArrayTail`](source/array-tail.d.ts) - Extracts the type of an array or tuple minus the first element.
|
||||
- [`ArraySplice`](source/array-splice.d.ts) - Create a new array type by adding or removing elements at a specified index range in the original array.
|
||||
- [`ArrayTail`](source/array-tail.d.ts) - Extract the type of an array or tuple minus the first element.
|
||||
- [`SetFieldType`](source/set-field-type.d.ts) - Create a type that changes the type of the given keys.
|
||||
- [`Paths`](source/paths.d.ts) - Generate a union of all possible paths to properties in the given object.
|
||||
- [`SharedUnionFields`](source/shared-union-fields.d.ts) - Create a type with shared fields from a union of object types.
|
||||
@ -241,7 +241,7 @@ Click the type names for complete docs.
|
||||
- [`Replace`](source/replace.d.ts) - Represents a string with some or all matches replaced by a replacement.
|
||||
- [`StringSlice`](source/string-slice.d.ts) - Returns a string slice of a given range, just like `String#slice()`.
|
||||
- [`StringRepeat`](source/string-repeat.d.ts) - Returns a new string which contains the specified number of copies of a given string, just like `String#repeat()`.
|
||||
- [`RemovePrefix`](source/remove-prefix.d.ts) - Removes the specified prefix from the start of a string.
|
||||
- [`RemovePrefix`](source/remove-prefix.d.ts) - Remove the specified prefix from the start of a string.
|
||||
|
||||
### Array
|
||||
|
||||
@ -249,7 +249,7 @@ Click the type names for complete docs.
|
||||
- [`Includes`](source/includes.d.ts) - Returns a boolean for whether the given array includes the given item.
|
||||
- [`Join`](source/join.d.ts) - Join an array of strings and/or numbers using the given string as a delimiter.
|
||||
- [`ArraySlice`](source/array-slice.d.ts) - Returns an array slice of a given range, just like `Array#slice()`.
|
||||
- [`LastArrayElement`](source/last-array-element.d.ts) - Extracts the type of the last element of an array.
|
||||
- [`LastArrayElement`](source/last-array-element.d.ts) - Extract the type of the last element of an array.
|
||||
- [`FixedLengthArray`](source/fixed-length-array.d.ts) - Create a type that represents an array of the given type and length. The `Array` prototype methods that manipulate its length are excluded from the resulting type.
|
||||
- [`MultidimensionalArray`](source/multidimensional-array.d.ts) - Create a type that represents a multidimensional array of the given type and dimensions.
|
||||
- [`MultidimensionalReadonlyArray`](source/multidimensional-readonly-array.d.ts) - Create a type that represents a multidimensional readonly array of the given type and dimensions.
|
||||
@ -257,10 +257,10 @@ Click the type names for complete docs.
|
||||
- [`TupleToUnion`](source/tuple-to-union.d.ts) - Convert a tuple/array into a union type of its elements.
|
||||
- [`UnionToTuple`](source/union-to-tuple.d.ts) - Convert a union type into an unordered tuple type of its elements.
|
||||
- [`TupleToObject`](source/tuple-to-object.d.ts) - Transforms a tuple into an object, mapping each tuple index to its corresponding type as a key-value pair.
|
||||
- [`TupleOf`](source/tuple-of.d.ts) - Creates a tuple type of the specified length with elements of the specified type.
|
||||
- [`TupleOf`](source/tuple-of.d.ts) - Create a tuple type of the specified length with elements of the specified type.
|
||||
- [`SplitOnRestElement`](source/split-on-rest-element.d.ts) - Splits an array into three parts, where the first contains all elements before the rest element, the second is the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element itself, and the third contains all elements after the rest element.
|
||||
- [`ExtractRestElement`](source/extract-rest-element.d.ts) - Extracts the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element type from an array.
|
||||
- [`ExcludeRestElement`](source/exclude-rest-element.d.ts) - Creates a tuple with the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element removed.
|
||||
- [`ExtractRestElement`](source/extract-rest-element.d.ts) - Extract the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element type from an array.
|
||||
- [`ExcludeRestElement`](source/exclude-rest-element.d.ts) - Create a tuple with the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element removed.
|
||||
|
||||
### Numeric
|
||||
|
||||
@ -290,11 +290,11 @@ Click the type names for complete docs.
|
||||
- [`CamelCasedProperties`](source/camel-cased-properties.d.ts) - Convert object properties to camel-case (`fooBar`).
|
||||
- [`CamelCasedPropertiesDeep`](source/camel-cased-properties-deep.d.ts) - Convert object properties to camel-case recursively (`fooBar`).
|
||||
- [`KebabCase`](source/kebab-case.d.ts) - Convert a string literal to kebab-case (`foo-bar`).
|
||||
- [`KebabCasedProperties`](source/kebab-cased-properties.d.ts) - Convert a object properties to kebab-case recursively (`foo-bar`).
|
||||
- [`KebabCasedPropertiesDeep`](source/kebab-cased-properties-deep.d.ts) - Convert object properties to kebab-case (`foo-bar`).
|
||||
- [`PascalCase`](source/pascal-case.d.ts) - Converts a string literal to pascal-case (`FooBar`)
|
||||
- [`PascalCasedProperties`](source/pascal-cased-properties.d.ts) - Converts object properties to pascal-case (`FooBar`)
|
||||
- [`PascalCasedPropertiesDeep`](source/pascal-cased-properties-deep.d.ts) - Converts object properties to pascal-case (`FooBar`)
|
||||
- [`KebabCasedProperties`](source/kebab-cased-properties.d.ts) - Convert object properties to kebab-case (`foo-bar`).
|
||||
- [`KebabCasedPropertiesDeep`](source/kebab-cased-properties-deep.d.ts) - Convert object properties to kebab-case recursively (`foo-bar`).
|
||||
- [`PascalCase`](source/pascal-case.d.ts) - Convert a string literal to pascal-case (`FooBar`).
|
||||
- [`PascalCasedProperties`](source/pascal-cased-properties.d.ts) - Convert object properties to pascal-case (`FooBar`).
|
||||
- [`PascalCasedPropertiesDeep`](source/pascal-cased-properties-deep.d.ts) - Convert object properties to pascal-case recursively (`FooBar`).
|
||||
- [`SnakeCase`](source/snake-case.d.ts) - Convert a string literal to snake-case (`foo_bar`).
|
||||
- [`SnakeCasedProperties`](source/snake-cased-properties.d.ts) - Convert object properties to snake-case (`foo_bar`).
|
||||
- [`SnakeCasedPropertiesDeep`](source/snake-cased-properties-deep.d.ts) - Convert object properties to snake-case recursively (`foo_bar`).
|
||||
|
||||
2
source/array-splice.d.ts
vendored
2
source/array-splice.d.ts
vendored
@ -64,7 +64,7 @@ type SplitArrayByIndex<T extends UnknownArray, SplitIndex extends number> =
|
||||
: SplitFixedArrayByIndex<T, SplitIndex>;
|
||||
|
||||
/**
|
||||
Creates a new array type by adding or removing elements at a specified index range in the original array.
|
||||
Create a new array type by adding or removing elements at a specified index range in the original array.
|
||||
|
||||
Use-case: Replace or insert items in an array type.
|
||||
|
||||
|
||||
2
source/array-tail.d.ts
vendored
2
source/array-tail.d.ts
vendored
@ -3,7 +3,7 @@ import type {IfNotAnyOrNever, IsArrayReadonly} from './internal/index.d.ts';
|
||||
import type {UnknownArray} from './unknown-array.d.ts';
|
||||
|
||||
/**
|
||||
Extracts the type of an array or tuple minus the first element.
|
||||
Extract the type of an array or tuple minus the first element.
|
||||
|
||||
@example
|
||||
```
|
||||
|
||||
2
source/exclude-rest-element.d.ts
vendored
2
source/exclude-rest-element.d.ts
vendored
@ -3,7 +3,7 @@ import type {IsArrayReadonly} from './internal/array.d.ts';
|
||||
import type {UnknownArray} from './unknown-array.d.ts';
|
||||
|
||||
/**
|
||||
Creates a tuple with the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element removed.
|
||||
Create a tuple with the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element removed.
|
||||
|
||||
@example
|
||||
```
|
||||
|
||||
2
source/extract-rest-element.d.ts
vendored
2
source/extract-rest-element.d.ts
vendored
@ -2,7 +2,7 @@ import type {SplitOnRestElement} from './split-on-rest-element.d.ts';
|
||||
import type {UnknownArray} from './unknown-array.d.ts';
|
||||
|
||||
/**
|
||||
Extracts the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element type from an array.
|
||||
Extract the [`rest`](https://www.typescriptlang.org/docs/handbook/2/objects.html#tuple-types) element type from an array.
|
||||
|
||||
@example
|
||||
```
|
||||
|
||||
2
source/last-array-element.d.ts
vendored
2
source/last-array-element.d.ts
vendored
@ -1,5 +1,5 @@
|
||||
/**
|
||||
Extracts the type of the last element of an array.
|
||||
Extract the type of the last element of an array.
|
||||
|
||||
Use-case: Defining the return type of functions that extract the last element of an array, for example [`lodash.last`](https://lodash.com/docs/4.17.15#last).
|
||||
|
||||
|
||||
2
source/pascal-case.d.ts
vendored
2
source/pascal-case.d.ts
vendored
@ -2,7 +2,7 @@ import type {CamelCase, CamelCaseOptions, _DefaultCamelCaseOptions} from './came
|
||||
import type {ApplyDefaultOptions} from './internal/index.d.ts';
|
||||
|
||||
/**
|
||||
Converts a string literal to pascal-case.
|
||||
Convert a string literal to pascal-case.
|
||||
|
||||
@example
|
||||
```
|
||||
|
||||
2
source/remove-prefix.d.ts
vendored
2
source/remove-prefix.d.ts
vendored
@ -83,7 +83,7 @@ type DefaultRemovePrefixOptions = {
|
||||
};
|
||||
|
||||
/**
|
||||
Removes the specified prefix from the start of a string.
|
||||
Remove the specified prefix from the start of a string.
|
||||
|
||||
@example
|
||||
```
|
||||
|
||||
2
source/tuple-of.d.ts
vendored
2
source/tuple-of.d.ts
vendored
@ -4,7 +4,7 @@ import type {IsNegative} from './numeric.d.ts';
|
||||
import type {UnknownArray} from './unknown-array.d.ts';
|
||||
|
||||
/**
|
||||
Creates a tuple type of the specified length with elements of the specified type.
|
||||
Create a tuple type of the specified length with elements of the specified type.
|
||||
|
||||
@example
|
||||
```
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user