This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import { useEffect, useState } from "react"; | |
/** | |
* A hook to observe the intersection of elements and return the IDs of those | |
* that are intersecting. | |
* @param ids The IDs of the elements to observe | |
* @param options The options to pass to the IntersectionObserver | |
* | |
* @example | |
* ```tsx |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Merge the keys of a union or intersection of objects into a single type. | |
* | |
* @example | |
* ```ts | |
* type GetBlockOptions = { | |
* includeTransactions?: boolean | undefined | |
* } & ( | |
* | { | |
* blockHash?: string | undefined; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Convert members of a union to an intersection. | |
* | |
* @example | |
* ```ts | |
* type Union = { a: number } | { b: string }; | |
* type Intersection = UnionToIntersection<Union>; | |
* // { a: number } & { b: string } | |
* ``` | |
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* A utility type that returns a union of space-separated words in a string. | |
* | |
* @example | |
* ```ts | |
* type Foo = Words<'foo bar baz'>; | |
* // => 'foo' | 'bar' | 'baz' | |
*/ | |
type Words<TString extends string> = | |
TString extends `${infer Word} ${infer Rest}` ? Word | Words<Rest> : TString; |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Converts array or tuple `T` to an object with keys as indices and values as element types. | |
* It's handy for when you need type-safe access based on indices, especially with tuples. | |
* | |
* `ByIndex` is useful over `{ [K in keyof T]: T[K] }` for: | |
* - Keeping index keys as strings for object mapping from tuples. | |
* - Handling arrays as tuples for a unified index-based object structure. | |
* | |
* Example: | |
* type ExampleTuple = ByIndex<[string, number]>; // { "0": string, "1": number } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Attempts to get the path to the file that called the function that called | |
* this function. | |
* @example | |
* | |
* #### Caller: | |
* ```ts | |
* // /path/to/file.ts | |
* import { foo } from './path/to/foo.ts'; | |
* |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Converts a hyphenated string to camel case. | |
* | |
* @example | |
* camelCase('foo-bar') // 'fooBar' | |
*/ | |
export function camelCase<S>(str: S): CamelCase<S> { | |
return ( | |
typeof str === 'string' | |
? str.toLowerCase().replace(/-+([^-])/g, (_, c) => c.toUpperCase()) |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
import os from "node:os"; | |
import path from "node:path"; | |
/** | |
* Get the path to an app specific config directory based on operating system | |
* standards. | |
* @param projectName | |
* @returns | |
*/ | |
export function getOSConfigDir(projectName: string): string { |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Conducts a binary search on a sorted array of items to find the index of a | |
* specific target. If the target is not found, it returns the nearest index | |
* based on the comparator function. | |
* | |
* @param items - The sorted array of items to search within. | |
* @param compare - A comparator function that returns: | |
* - a negative number if `item` is less than the target, | |
* - a positive number if `item` is greater than the target, | |
* - and 0 if `item` is equal to the target. |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
/** | |
* Construct a type based off T where TDefinedField is defined when | |
* T matches TDefinedState. | |
*/ | |
type DefinedWhen< | |
T extends Record<string, any>, | |
TDefinedField extends keyof T, | |
TDefinedState extends Partial<T>, | |
> = | |
| (Omit<T, TDefinedField | keyof TDefinedState> & |
NewerOlder