@augment-vir/common 11.1.2 → 11.3.0

package/README.md

@@ -1,5 +1,5 @@
 # @augment-vir/common
 
-`augment-vir` is a collection of small helper functions that I constantly use across all my JavaScript and TypeScript repos. I call these functions `augments`. These are things commonly placed within a "util", or "helpers", etc. directory; they don't really have anything in common with each other except that they have almost no dependencies.
+`augment-vir` is a collection of small helper functions that I constantly use across all my JavaScript and TypeScript repos. I call these functions `augments`. These are functions, constants, and types typically placed within a "util", or "helpers", etc. directory.
 
 This `common` package is for environment-agnostic augments. Everything in here will work in Node.js or the browser with identical results.

package/dist/cjs/augments/type.d.ts

@@ -23,6 +23,8 @@ export type SetOptionalAndNullable<OriginalObjectGeneric, OptionalKeysGeneric ex
 }>;
 /** Require only a subset of object properties. */
 export type RequiredBy<T, K extends keyof T> = Overwrite<T, Required<Pick<T, K>>>;
+export declare function makeWritable<T>(input: T): Writeable<T>;
+export declare function makeReadonly<T>(input: T): Readonly<T>;
 /**
  * Require only a subset of object properties and require that they be not null. This is
  * particularly useful in conjunction with the "exactOptionalPropertyTypes" tsconfig flag.

package/dist/cjs/augments/type.js

@@ -1,6 +1,14 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ensureType = exports.wrapNarrowTypeWithTypeCheck = void 0;
+exports.ensureType = exports.wrapNarrowTypeWithTypeCheck = exports.makeReadonly = exports.makeWritable = void 0;
+function makeWritable(input) {
+    return input;
+}
+exports.makeWritable = makeWritable;
+function makeReadonly(input) {
+    return input;
+}
+exports.makeReadonly = makeReadonly;
 /**
  * This function returns another function that simply returns whatever input it's given. However, it
  * also checks that the input matches the original wrapNarrowTypeWithTypeCheck's generic, while

package/dist/esm/augments/type.d.ts

@@ -23,6 +23,8 @@ export type SetOptionalAndNullable<OriginalObjectGeneric, OptionalKeysGeneric ex
 }>;
 /** Require only a subset of object properties. */
 export type RequiredBy<T, K extends keyof T> = Overwrite<T, Required<Pick<T, K>>>;
+export declare function makeWritable<T>(input: T): Writeable<T>;
+export declare function makeReadonly<T>(input: T): Readonly<T>;
 /**
  * Require only a subset of object properties and require that they be not null. This is
  * particularly useful in conjunction with the "exactOptionalPropertyTypes" tsconfig flag.

package/dist/esm/augments/type.js

@@ -1,3 +1,9 @@
+export function makeWritable(input) {
+    return input;
+}
+export function makeReadonly(input) {
+    return input;
+}
 /**
  * This function returns another function that simply returns whatever input it's given. However, it
  * also checks that the input matches the original wrapNarrowTypeWithTypeCheck's generic, while

package/dist/types/augments/type.d.ts

@@ -23,6 +23,8 @@ export type SetOptionalAndNullable<OriginalObjectGeneric, OptionalKeysGeneric ex
 }>;
 /** Require only a subset of object properties. */
 export type RequiredBy<T, K extends keyof T> = Overwrite<T, Required<Pick<T, K>>>;
+export declare function makeWritable<T>(input: T): Writeable<T>;
+export declare function makeReadonly<T>(input: T): Readonly<T>;
 /**
  * Require only a subset of object properties and require that they be not null. This is
  * particularly useful in conjunction with the "exactOptionalPropertyTypes" tsconfig flag.

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "@augment-vir/common",
-    "version": "11.1.2",
+    "version": "11.3.0",
     "homepage": "https://github.com/electrovir/augment-vir/tree/main/packages/common",
     "bugs": {
         "url": "https://github.com/electrovir/augment-vir/issues"