Skip to content

Commit a50d186

Browse files
committed
doc: sanitize JsDoc
1 parent cdc27fc commit a50d186

File tree

4 files changed

+9
-9
lines changed

4 files changed

+9
-9
lines changed

readme.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -161,9 +161,9 @@ Click the type names for complete docs.
161161
- [`WritableKeysOf`](source/writable-keys-of.d.ts) - Extract all writable (non-readonly) keys from the given type.
162162
- [`HasWritableKeys`](source/has-writable-keys.d.ts) - Create a `true`/`false` type depending on whether the given type has any writable fields.
163163
- [`Spread`](source/spread.d.ts) - Mimic the type inferred by TypeScript when merging two objects or two arrays/tuples using the spread syntax.
164-
- [`SplitOnSpread`](source/split-on-spread.d.ts) - Splits an Array on its spreaded portion. return's `[[...Head], [Spread], [...Tail]]`.
165-
- [`ExtractSpread`](source/split-on-spread.d.ts) - Return's the spread element type from and array.
166-
- [`ExcludeSpread`](source/split-on-spread.d.ts) - Create a array with the spread element removed.
164+
- [`SplitOnSpread`](source/split-on-spread.d.ts) - Splits an array on its spread portion into three parts: `[[...Head], [Spread], [...Tail]]`.
165+
- [`ExtractSpread`](source/split-on-spread.d.ts) - Extracts the spread element type from an array.
166+
- [`ExcludeSpread`](source/split-on-spread.d.ts) - Creates a tuple with the spread element removed.
167167
- [`IsEqual`](source/is-equal.d.ts) - Returns a boolean for whether the two given types are equal.
168168
- [`TaggedUnion`](source/tagged-union.d.ts) - Create a union of types that share a common discriminant property.
169169
- [`IntRange`](source/int-range.d.ts) - Generate a union of numbers (includes the start and excludes the end).

source/exclude-spread.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ import type {SplitOnSpread} from './split-on-spread.d.ts';
33
import type {UnknownArray} from './unknown-array.d.ts';
44

55
/**
6-
Create a tuple with the spread element removed.
6+
Creates a tuple with the spread element removed.
77
88
@example
99
```
@@ -31,5 +31,5 @@ export type ExcludeSpread<Array_ extends UnknownArray> =
3131
? IsArrayReadonly<Array_> extends true
3232
? Readonly<[...Result[0], ...Result[2]]>
3333
: [...Result[0], ...Result[2]]
34-
: Result // `never` or `any`
34+
: Result // May be `never` or `any`
3535
: never;

source/extract-spread.d.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@ import type {SplitOnSpread} from './split-on-spread.d.ts';
22
import type {UnknownArray} from './unknown-array.d.ts';
33

44
/**
5-
Returns the spread element type from an array.
5+
Extracts the spread element type from an array.
66
77
@example
88
```

source/split-on-spread.d.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,15 +21,15 @@ type DefaultSplitOnSpreadOptions = {
2121
};
2222

2323
/**
24-
Splits an Array on its spreaded portion. into three parts:
24+
Splits an array on its spread portion into three parts:
2525
2626
1. The static (non-spread) prefix before any spread element.
2727
2. The inferred spread type (e.g., `string` from `...string[]`) as a single-element tuple.
2828
3. The static suffix after the spread (if any).
2929
3030
If no spread exists, the entire array is treated as a static prefix with empty spread and suffix parts.
3131
32-
By default, Optional modifier (`?`) is preserved. See {@link SplitOnSpreadOptions.keepOptionals keepOptionals} option to change this behaviour.
32+
By default, The optional modifier (?) is preserved. See {@link SplitOnSpreadOptions.keepOptionals keepOptionals} option to change this behavior.
3333
3434
@example
3535
```ts
@@ -59,7 +59,7 @@ export type SplitOnSpread<Array_ extends UnknownArray, Options extends SplitOnSp
5959
>;
6060

6161
/**
62-
Deconstruct an Array on its rest element and return the split portions.
62+
Deconstructs an array on its rest element and returns the split portions.
6363
6464
See {@link SplitOnSpread SplitOnSpread} for details.
6565
*/

0 commit comments

Comments
 (0)