@greenymcgee/utility-types 0.1.0

package/README.md

@@ -0,0 +1,64 @@
+# Utility Types
+
+These are a set of utility types that I use in my projects.
+
+## Installation
+
+```bash
+# npm
+npm install -D @greenymcgee/utility-types
+
+# pnpm
+pnpm add -D @greenymcgee/utility-types
+```
+
+## Usage
+
+I suggest adding a reference in a top level `types.d.ts` file.
+
+```ts
+/// <reference types="@greenymcgee/utility-types" />
+```
+
+## Types
+
+### FirstParameterOf
+
+Used to get the first parameter of a function.
+
+```ts
+type YourType = FirstParameterOf<typeof yourFunction>
+```
+
+### SecondParameterOf
+
+Used to get the second parameter of a function.
+
+```ts
+type YourType = SecondParameterOf<typeof yourFunction>
+```
+
+### ThirdParameterOf
+
+Used to get the third parameter of a function.
+
+```ts
+type YourType = ThirdParameterOf<typeof yourFunction>
+```
+
+### PropsOf
+
+Used to get the props of a component.
+
+```ts
+type YourProps = PropsOf<typeof YourComponent>
+```
+
+### OneOf
+
+Used to get the first element of an array. Very useful if you have
+an array of typed objects, but don't need a type for the objects themselves.
+
+```ts
+type YourType = OneOf<typeof yourArray>
+```

package/index.d.ts

@@ -0,0 +1,28 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */
+
+/**
+ * Utility types for grabbing the first three parameters of a method.
+ */
+type FirstParameterOf<Method extends (...args: any) => any> =
+  Parameters<Method>[0];
+type SecondParameterOf<Method extends (...args: any) => any> =
+  Parameters<Method>[1];
+type ThirdParameterOf<Method extends (...args: any) => any> =
+  Parameters<Method>[2];
+
+type ConstructorParams<Constructor extends new (...args: any) => any> =
+  Constructor extends new (...args: infer Params) => any ? Params : never;
+
+type FirstConstructorParameterOf<Klass extends new (...args: any) => any> =
+  ConstructorParams<Klass>[0];
+
+/**
+ * An alias for FirstParameterOf. It's a littles easier to read when working
+ * with components.
+ */
+type PropsOf<Component extends (...args: any) => any> =
+  FirstParameterOf<Component>;
+
+type OneOf<AnyArray extends Array<unknown>> = AnyArray[0];
+
+/* eslint-enable @typescript-eslint/no-explicit-any */

package/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "@greenymcgee/utility-types",
+  "version": "0.1.0",
+  "type": "module",
+  "types": "./index.d.ts"
+}

package/tsconfig.json

@@ -0,0 +1,16 @@
+
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "allowJs": false,
+    "strict": true,
+    "noEmit": true,
+    "esModuleInterop": true,
+    "moduleResolution": "bundler",
+    "resolveJsonModule": true,
+    "isolatedModules": true,
+    "incremental": true,
+  },
+  "include": ["**/*.ts"],
+  "exclude": ["node_modules"]
+}