type-fest 2.0.0 → 2.1.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "type-fest",
-	"version": "2.0.0",
+	"version": "2.1.0",
 	"description": "A collection of essential TypeScript types",
 	"license": "(MIT OR CC0-1.0)",
 	"repository": "sindresorhus/type-fest",

package/readme.md

@@ -121,7 +121,7 @@ Click the type names for complete docs.
 - [`Entries`](source/entries.d.ts) - Create a type that represents the type of the entries of a collection.
 - [`SetReturnType`](source/set-return-type.d.ts) - Create a function type with a return type of your choice and the same parameters as the given function type.
 - [`Asyncify`](source/asyncify.d.ts) - Create an async version of the given function type.
-- [`Includes`](source/includes.ts) - Returns a boolean for whether the given array includes the given item.
+- [`Includes`](source/includes.d.ts) - Returns a boolean for whether the given array includes the given item.
 - [`Simplify`](source/simplify.d.ts) - Flatten the type output to improve type hints shown in editors.
 - [`Jsonify`](source/jsonify.d.ts) - Transform a type to one that is assignable to the `JsonValue` type.
 

package/source/camel-case.d.ts

@@ -8,7 +8,7 @@ Only to be used by `CamelCaseStringArray<>`.
 
 @see CamelCaseStringArray
 */
-type InnerCamelCaseStringArray<Parts extends any[], PreviousPart> =
+type InnerCamelCaseStringArray<Parts extends readonly any[], PreviousPart> =
 	Parts extends [`${infer FirstPart}`, ...infer RemainingParts]
 		? FirstPart extends undefined
 			? ''
@@ -24,7 +24,7 @@ It's separate from `InnerCamelCaseStringArray<>` to keep a clean API outwards to
 
 @see Split
 */
-type CamelCaseStringArray<Parts extends string[]> =
+type CamelCaseStringArray<Parts extends readonly string[]> =
 	Parts extends [`${infer FirstPart}`, ...infer RemainingParts]
 		? Uncapitalize<`${FirstPart}${InnerCamelCaseStringArray<RemainingParts, FirstPart>}`>
 		: never;

package/source/delimiter-case.d.ts

@@ -36,7 +36,7 @@ It receives `UsedWordSeparators` and `UsedUpperCaseCharacters` as input to ensur
 
 @see SplitIncludingDelimiters
 */
-type StringArrayToDelimiterCase<Parts extends any[], UsedWordSeparators extends string, UsedUpperCaseCharacters extends string, Delimiter extends string> =
+type StringArrayToDelimiterCase<Parts extends readonly any[], UsedWordSeparators extends string, UsedUpperCaseCharacters extends string, Delimiter extends string> =
 	Parts extends [`${infer FirstPart}`, ...infer RemainingParts]
 		? `${StringPartToDelimiterCase<FirstPart, UsedWordSeparators, UsedUpperCaseCharacters, Delimiter>}${StringArrayToDelimiterCase<RemainingParts, UsedWordSeparators, UsedUpperCaseCharacters, Delimiter>}`
 		: '';

package/source/entries.d.ts

@@ -54,6 +54,6 @@ const setEntries: Entries<typeof setExample> = [['a', 'a'], [1, 1]];
 export type Entries<BaseType> =
 	BaseType extends Map<unknown, unknown> ? MapEntries<BaseType>
 		: BaseType extends Set<unknown> ? SetEntries<BaseType>
-		: BaseType extends unknown[] ? ArrayEntries<BaseType>
+		: BaseType extends readonly unknown[] ? ArrayEntries<BaseType>
 		: BaseType extends object ? ObjectEntries<BaseType>
 		: never;

package/source/entry.d.ts

@@ -57,6 +57,6 @@ const setEntryNumber: Entry<typeof setExample> = [1, 1];
 export type Entry<BaseType> =
 	BaseType extends Map<unknown, unknown> ? MapEntry<BaseType>
 		: BaseType extends Set<unknown> ? SetEntry<BaseType>
-		: BaseType extends unknown[] ? ArrayEntry<BaseType>
+		: BaseType extends readonly unknown[] ? ArrayEntry<BaseType>
 		: BaseType extends object ? ObjectEntry<BaseType>
 		: never;

package/source/includes.d.ts

@@ -1,5 +1,5 @@
 /**
-Returns a boolean for whether given two types are equal.
+Returns a boolean for whether the two given types are equal.
 
 @link https://github.com/microsoft/TypeScript/issues/27024#issuecomment-421529650
 */
@@ -23,7 +23,7 @@ type hasRed<array extends any[]> = Includes<array, 'red'>;
 
 @category Utilities
 */
-export type Includes<Value extends any[], Item> =
+export type Includes<Value extends readonly any[], Item> =
 	IsEqual<Value[0], Item> extends true
 		? true
 		: Value extends [Value[0], ...infer rest]

package/source/last-array-element.d.ts

@@ -7,7 +7,7 @@ Use-case: Defining the return type of functions that extract the last element of
 ```
 import {LastArrayElement} from 'type-fest';
 
-declare function lastOf<V extends any[]>(array: V): LastArrayElement<V>;
+declare function lastOf<V extends readonly any[]>(array: V): LastArrayElement<V>;
 
 const array = ['foo', 2];
 
@@ -17,7 +17,7 @@ typeof lastOf(array);
 
 @category Template Literals
 */
-export type LastArrayElement<ValueType extends unknown[]> =
+export type LastArrayElement<ValueType extends readonly unknown[]> =
 	ValueType extends [infer ElementType]
 		? ElementType
 		: ValueType extends [infer _, ...infer Tail]

package/source/observable-like.d.ts

@@ -9,7 +9,7 @@ Matches a value that is like an [Observable](https://github.com/tc39/proposal-ob
 
 @category Basic
 */
-export interface ObservableLike {
-	subscribe(observer: (value: unknown) => void): void;
-	[Symbol.observable](): ObservableLike;
+export interface ObservableLike<ValueType = unknown> {
+	subscribe(observer: (value: ValueType) => void): void;
+	[Symbol.observable](): ObservableLike<ValueType>;
 }