PickIndexSignature/OmitIndexSignature: Clean up JSDoc comments (#…

…1039)
sindresorhus · Jan 15, 2025 · 879d8ae · 879d8ae
1 parent 979eccf
commit 879d8ae
Show file tree

Hide file tree

Showing 2 changed files with 0 additions and 64 deletions.
diff --git a/source/omit-index-signature.d.ts b/source/omit-index-signature.d.ts
@@ -61,18 +61,6 @@ type OmitIndexSignature<ObjectType> = {
 
 If `{}` is assignable, it means that `KeyType` is an index signature and we want to remove it. If it is not assignable, `KeyType` is a "real" key and we want to keep it.
 
-```
-import type {OmitIndexSignature} from 'type-fest';
-
-type OmitIndexSignature<ObjectType> = {
-	[KeyType in keyof ObjectType
-		as {} extends Record<KeyType, unknown>
-			? never // => Remove this `KeyType`.
-			: KeyType // => Keep this `KeyType` as it is.
-	]: ObjectType[KeyType];
-};
-```
-
 @example
 ```
 import type {OmitIndexSignature} from 'type-fest';

diff --git a/source/pick-index-signature.d.ts b/source/pick-index-signature.d.ts
@@ -3,8 +3,6 @@ Pick only index signatures from the given object type, leaving out all explicitl
 
 This is the counterpart of `OmitIndexSignature`.
 
-When you use a type that will iterate through an object that has indexed keys and explicitly defined keys you end up with a type where only the indexed keys are kept. This is because `keyof` of an indexed type always returns `string | number | symbol`, because every key is possible in that object. With this type, you can save the indexed keys and reinject them later, like in the second example below.
-
 @example
 ```
 import type {PickIndexSignature} from 'type-fest';
@@ -42,56 +40,6 @@ type ExampleIndexSignature = PickIndexSignature<Example>;
 // }
 ```
 
-@example
-```
-import type {OmitIndexSignature, PickIndexSignature, Simplify} from 'type-fest';
-
-type Foo = {
-	[x: string]: string;
-	foo: string;
-	bar: number;
-};
-
-// Imagine that you want a new type `Bar` that comes from `Foo`.
-// => {
-// 	[x: string]: string;
-// 	bar: number;
-// };
-
-type Bar = Omit<Foo, 'foo'>;
-// This is not working because `Omit` returns only indexed keys.
-// => {
-// 	[x: string]: string;
-// 	[x: number]: string;
-// }
-
-// One solution is to save the indexed signatures to new type.
-type FooIndexSignature = PickIndexSignature<Foo>;
-// => {
-// 	[x: string]: string;
-// }
-
-// Get a new type without index signatures.
-type FooWithoutIndexSignature = OmitIndexSignature<Foo>;
-// => {
-// 	foo: string;
-// 	bar: number;
-// }
-
-// At this point we can use Omit to get our new type.
-type BarWithoutIndexSignature = Omit<FooWithoutIndexSignature, 'foo'>;
-// => {
-// 	bar: number;
-// }
-
-// And finally we can merge back the indexed signatures.
-type BarWithIndexSignature = Simplify<BarWithoutIndexSignature & FooIndexSignature>;
-// => {
-// 	[x: string]: string;
-// 	bar: number;
-// }
-```
-
 @see OmitIndexSignature
 @category Object
 */