innocuous-symmetry/utility-closet
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

init; collecting some of my commonly used utils

Browse Source
This commit is contained in:
Mikayla Dobson
2024-04-01 17:31:33 -05:00
commit a09a7d7337
13 changed files with 322 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
.gitignore vendored Normal file
View File

@@ -0,0 +1,2 @@
node_modules/
package-lock.json

0
index.ts Normal file
View File

24
package.json Normal file
View File

@@ -0,0 +1,24 @@
{
"name": "utility-closet",
"version": "1.0.0",
"main": "index.js",
"scripts": {
"test": "echo \"Error: no test specified\" && exit 1"
},
"keywords": [],
"author": "",
"license": "ISC",
"dependencies": {
"csv-parse": "^5.5.5",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"typescript": "^5.3.3",
"zod": "^3.22.4"
},
"description": "",
"devDependencies": {
"@types/csv-parse": "^1.2.2",
"@types/react": "^18.2.73",
"vitest": "^1.4.0"
}
}

14
pkg/async.ts Normal file
View File

@@ -0,0 +1,14 @@
export async function promiseAllSafe<T>(tasks: Promise<T>[]) {
return await Promise.allSettled(tasks)
.then(res => {
const fulfilled: NonNullable<T>[] = [];
res.forEach(r => {
if (r.status == 'fulfilled' && r.value) {
fulfilled.push(r.value);
}
});
return fulfilled;
}) satisfies Awaited<NonNullable<T>[]>;
}

28
pkg/csv.ts Normal file
View File

@@ -0,0 +1,28 @@
import { Options, parse, Parser } from "csv-parse";
import { z } from "zod";
export async function readCSVToType<
TData extends Record<string, unknown>
>(
text: string,
validator: z.ZodType<TData>,
options?: Options
) {
options ??= {
columns: true,
ignore_last_delimiters: true,
skip_empty_lines: true,
relax_column_count: true
}
const parser = parse(text, options);
const records: TData[] = [];
for await (const record of parser as (Parser & AsyncIterable<never>)) {
records.push(
validator.parse(record)
)
}
return records;
}

21
pkg/dom.ts Normal file
View File

@@ -0,0 +1,21 @@
import React from 'react';
export type PickElementProps<
TElement extends keyof React.JSX.IntrinsicElements,
TProps extends keyof React.ComponentProps<TElement>
> = Pick<React.ComponentProps<TElement>, TProps>;
export function clickVirtualDownloadLink(
url: string,
filename: string,
) {
const a = document.createElement('a');
a.href = url;
a.download = filename;
a.target = "_blank";
document.body.appendChild(a);
a.click();
document.body.removeChild(a);
}

53
pkg/obj.ts Normal file
View File

@@ -0,0 +1,53 @@
/**
* Given an object, return a copy of the object with the specified properties removed.
*
* @param obj - the object to strip properties from
* @param keys - the properties to remove from the object
* @returns - the new object with the specified properties removed
*/
export function excludeFromObject<
TObj extends Record<string, unknown>
>(
obj: TObj,
...keys: (keyof TObj)[]
) {
const copy = { ...obj }
for (const key of keys) {
delete copy[key];
}
return copy satisfies Omit<TObj, typeof keys[number]>;
}
/** The functional opposite of `excludeFromObject` */
export function pickFromObject<
TObj extends Record<string, unknown>
>(
obj: TObj,
...keys: (keyof TObj)[]
) {
const copy = {} as Pick<TObj, keyof TObj>;
for (const key of keys) {
copy[key] = obj[key];
}
return copy;
}
export function hasAllKeys<
TObj extends Record<string, unknown>
>(obj: TObj, ...keys: (keyof TObj)[]) {
for (const key of keys) {
if (!obj[key]) return false;
}
return true;
}
export default class Obj {
static exclude = excludeFromObject;
static pick = pickFromObject;
static hasAllKeys = hasAllKeys;
}

40
pkg/queue.ts Normal file
View File

@@ -0,0 +1,40 @@
export default class Queue<TData> extends Array<TData> {
constructor(...items: TData[]) {
super(...items);
}
public get isEmpty() {
return this.length == 0;
}
public get isNotEmpty() {
return this.length > 0;
}
public enqueue(item: TData) {
this.push(item);
return this;
}
public dequeue() {
return this.shift();
}
public async* walk({ interval = 1000, chunkSize = 1 }) {
while (this.isNotEmpty) {
const item = this.getChunk(chunkSize);
await new Promise(resolve => setTimeout(resolve, interval));
yield item;
}
}
private getChunk(length: number) {
const chunk = [];
while (chunk.length < length && this.isNotEmpty) {
chunk.push(this.dequeue());
}
return chunk;
}
}

17
pkg/time.ts Normal file
View File

@@ -0,0 +1,17 @@
export default class Time {
static SECOND = 1000;
static MINUTE = this.SECOND * 60;
static HOUR = this.MINUTE * 60;
static DAY = this.HOUR * 24;
static WEEK = this.DAY * 7;
static MONTH = this.DAY * 30;
static YEAR = this.DAY * 365;
static seconds = (n: number) => n * this.SECOND;
static minutes = (n: number) => n * this.MINUTE;
static hours = (n: number) => n * this.HOUR;
static days = (n: number) => n * this.DAY;
static weeks = (n: number) => n * this.WEEK;
static months = (n: number) => n * this.MONTH;
static years = (n: number) => n * this.YEAR;
}

6
pkg/types.ts Normal file
View File

@@ -0,0 +1,6 @@
export type Callable<
TReturn = void,
TArgs extends unknown[] = unknown[]
> = (...args: TArgs) => TReturn;
export type Maybe<T> = T | null | undefined;

7
pkg/validators.ts Normal file
View File

@@ -0,0 +1,7 @@
export function must<T = unknown>(
evaluation: T,
errorMessage = "Failed to fulfill requirements for function"
): NonNullable<T> | never {
if (!evaluation) throw new Error(errorMessage);
return evaluation;
}

109
tsconfig.json Normal file
View File

@@ -0,0 +1,109 @@
{
"compilerOptions": {
/* Visit https://aka.ms/tsconfig to read more about this file */
/* Projects */
// "incremental": true, /* Save .tsbuildinfo files to allow for incremental compilation of projects. */
// "composite": true, /* Enable constraints that allow a TypeScript project to be used with project references. */
// "tsBuildInfoFile": "./.tsbuildinfo", /* Specify the path to .tsbuildinfo incremental compilation file. */
// "disableSourceOfProjectReferenceRedirect": true, /* Disable preferring source files instead of declaration files when referencing composite projects. */
// "disableSolutionSearching": true, /* Opt a project out of multi-project reference checking when editing. */
// "disableReferencedProjectLoad": true, /* Reduce the number of projects loaded automatically by TypeScript. */
/* Language and Environment */
"target": "es2020", /* Set the JavaScript language version for emitted JavaScript and include compatible library declarations. */
// "lib": [], /* Specify a set of bundled library declaration files that describe the target runtime environment. */
// "jsx": "preserve", /* Specify what JSX code is generated. */
// "experimentalDecorators": true, /* Enable experimental support for legacy experimental decorators. */
// "emitDecoratorMetadata": true, /* Emit design-type metadata for decorated declarations in source files. */
// "jsxFactory": "", /* Specify the JSX factory function used when targeting React JSX emit, e.g. 'React.createElement' or 'h'. */
// "jsxFragmentFactory": "", /* Specify the JSX Fragment reference used for fragments when targeting React JSX emit e.g. 'React.Fragment' or 'Fragment'. */
// "jsxImportSource": "", /* Specify module specifier used to import the JSX factory functions when using 'jsx: react-jsx*'. */
// "reactNamespace": "", /* Specify the object invoked for 'createElement'. This only applies when targeting 'react' JSX emit. */
// "noLib": true, /* Disable including any library files, including the default lib.d.ts. */
// "useDefineForClassFields": true, /* Emit ECMAScript-standard-compliant class fields. */
// "moduleDetection": "auto", /* Control what method is used to detect module-format JS files. */
/* Modules */
"module": "commonjs", /* Specify what module code is generated. */
// "rootDir": "./", /* Specify the root folder within your source files. */
// "moduleResolution": "node10", /* Specify how TypeScript looks up a file from a given module specifier. */
// "baseUrl": "./", /* Specify the base directory to resolve non-relative module names. */
// "paths": {}, /* Specify a set of entries that re-map imports to additional lookup locations. */
// "rootDirs": [], /* Allow multiple folders to be treated as one when resolving modules. */
// "typeRoots": [], /* Specify multiple folders that act like './node_modules/@types'. */
// "types": [], /* Specify type package names to be included without being referenced in a source file. */
// "allowUmdGlobalAccess": true, /* Allow accessing UMD globals from modules. */
// "moduleSuffixes": [], /* List of file name suffixes to search when resolving a module. */
// "allowImportingTsExtensions": true, /* Allow imports to include TypeScript file extensions. Requires '--moduleResolution bundler' and either '--noEmit' or '--emitDeclarationOnly' to be set. */
// "resolvePackageJsonExports": true, /* Use the package.json 'exports' field when resolving package imports. */
// "resolvePackageJsonImports": true, /* Use the package.json 'imports' field when resolving imports. */
// "customConditions": [], /* Conditions to set in addition to the resolver-specific defaults when resolving imports. */
// "resolveJsonModule": true, /* Enable importing .json files. */
// "allowArbitraryExtensions": true, /* Enable importing files with any extension, provided a declaration file is present. */
// "noResolve": true, /* Disallow 'import's, 'require's or '<reference>'s from expanding the number of files TypeScript should add to a project. */
/* JavaScript Support */
// "allowJs": true, /* Allow JavaScript files to be a part of your program. Use the 'checkJS' option to get errors from these files. */
// "checkJs": true, /* Enable error reporting in type-checked JavaScript files. */
// "maxNodeModuleJsDepth": 1, /* Specify the maximum folder depth used for checking JavaScript files from 'node_modules'. Only applicable with 'allowJs'. */
/* Emit */
// "declaration": true, /* Generate .d.ts files from TypeScript and JavaScript files in your project. */
// "declarationMap": true, /* Create sourcemaps for d.ts files. */
// "emitDeclarationOnly": true, /* Only output d.ts files and not JavaScript files. */
// "sourceMap": true, /* Create source map files for emitted JavaScript files. */
// "inlineSourceMap": true, /* Include sourcemap files inside the emitted JavaScript. */
// "outFile": "./", /* Specify a file that bundles all outputs into one JavaScript file. If 'declaration' is true, also designates a file that bundles all .d.ts output. */
// "outDir": "./", /* Specify an output folder for all emitted files. */
// "removeComments": true, /* Disable emitting comments. */
// "noEmit": true, /* Disable emitting files from a compilation. */
// "importHelpers": true, /* Allow importing helper functions from tslib once per project, instead of including them per-file. */
// "importsNotUsedAsValues": "remove", /* Specify emit/checking behavior for imports that are only used for types. */
// "downlevelIteration": true, /* Emit more compliant, but verbose and less performant JavaScript for iteration. */
// "sourceRoot": "", /* Specify the root path for debuggers to find the reference source code. */
// "mapRoot": "", /* Specify the location where debugger should locate map files instead of generated locations. */
// "inlineSources": true, /* Include source code in the sourcemaps inside the emitted JavaScript. */
// "emitBOM": true, /* Emit a UTF-8 Byte Order Mark (BOM) in the beginning of output files. */
// "newLine": "crlf", /* Set the newline character for emitting files. */
// "stripInternal": true, /* Disable emitting declarations that have '@internal' in their JSDoc comments. */
// "noEmitHelpers": true, /* Disable generating custom helper functions like '__extends' in compiled output. */
// "noEmitOnError": true, /* Disable emitting files if any type checking errors are reported. */
// "preserveConstEnums": true, /* Disable erasing 'const enum' declarations in generated code. */
// "declarationDir": "./", /* Specify the output directory for generated declaration files. */
// "preserveValueImports": true, /* Preserve unused imported values in the JavaScript output that would otherwise be removed. */
/* Interop Constraints */
// "isolatedModules": true, /* Ensure that each file can be safely transpiled without relying on other imports. */
// "verbatimModuleSyntax": true, /* Do not transform or elide any imports or exports not marked as type-only, ensuring they are written in the output file's format based on the 'module' setting. */
// "allowSyntheticDefaultImports": true, /* Allow 'import x from y' when a module doesn't have a default export. */
"esModuleInterop": true, /* Emit additional JavaScript to ease support for importing CommonJS modules. This enables 'allowSyntheticDefaultImports' for type compatibility. */
// "preserveSymlinks": true, /* Disable resolving symlinks to their realpath. This correlates to the same flag in node. */
"forceConsistentCasingInFileNames": true, /* Ensure that casing is correct in imports. */
/* Type Checking */
"strict": true, /* Enable all strict type-checking options. */
// "noImplicitAny": true, /* Enable error reporting for expressions and declarations with an implied 'any' type. */
// "strictNullChecks": true, /* When type checking, take into account 'null' and 'undefined'. */
// "strictFunctionTypes": true, /* When assigning functions, check to ensure parameters and the return values are subtype-compatible. */
// "strictBindCallApply": true, /* Check that the arguments for 'bind', 'call', and 'apply' methods match the original function. */
// "strictPropertyInitialization": true, /* Check for class properties that are declared but not set in the constructor. */
// "noImplicitThis": true, /* Enable error reporting when 'this' is given the type 'any'. */
// "useUnknownInCatchVariables": true, /* Default catch clause variables as 'unknown' instead of 'any'. */
// "alwaysStrict": true, /* Ensure 'use strict' is always emitted. */
// "noUnusedLocals": true, /* Enable error reporting when local variables aren't read. */
// "noUnusedParameters": true, /* Raise an error when a function parameter isn't read. */
// "exactOptionalPropertyTypes": true, /* Interpret optional property types as written, rather than adding 'undefined'. */
// "noImplicitReturns": true, /* Enable error reporting for codepaths that do not explicitly return in a function. */
// "noFallthroughCasesInSwitch": true, /* Enable error reporting for fallthrough cases in switch statements. */
// "noUncheckedIndexedAccess": true, /* Add 'undefined' to a type when accessed using an index. */
// "noImplicitOverride": true, /* Ensure overriding members in derived classes are marked with an override modifier. */
// "noPropertyAccessFromIndexSignature": true, /* Enforces using indexed accessors for keys declared using an indexed type. */
// "allowUnusedLabels": true, /* Disable error reporting for unused labels. */
// "allowUnreachableCode": true, /* Disable error reporting for unreachable code. */
/* Completeness */
// "skipDefaultLibCheck": true, /* Skip type checking .d.ts files that are included with TypeScript. */
"skipLibCheck": true /* Skip type checking all .d.ts files. */
}
}

1
types/index.ts Normal file
View File

@@ -0,0 +1 @@