@koine/node 2.0.0-beta.132 → 2.0.0-beta.133

package/fsWrite.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Write file
+ *
+ * @param filepath The absolute file path
+ * @param content The file content string
+ * @param eol By default we apend a `node:os.EOL` end of line a the end of the file
+ */
 export declare function fsWrite(filepath: string, content: string, eol?: boolean): Promise<void>;
 export default fsWrite;

package/fsWriteSync.d.ts

@@ -1,2 +1,9 @@
+/**
+ * Write file
+ *
+ * @param filepath The absolute file path
+ * @param content The file content string
+ * @param eol By default we apend a `node:os.EOL` end of line a the end of the file
+ */
 export declare function fsWriteSync(filepath: string, content: string, eol?: boolean): void;
 export default fsWriteSync;

package/jest/jestCreateExpectedThrownError.d.ts

@@ -1,2 +1,14 @@
+/**
+ *
+ * @see https://stackoverflow.com/a/41407246/1938970
+ *
+ * @usage
+ * ```ts
+ * const err = jestCreateExpectedThrownError("@org/pkg", "fnName");
+ *
+ * // @ts-expect-error test wrong implementation
+ * err(() => fnName("wrong arguments implementation"));
+ * ```
+ */
 export declare const jestCreateExpectedThrownError: (pkgName: string, fnName: string) => (expectFn: () => ReturnType<jest.Expect>) => void;
 export default jestCreateExpectedThrownError;

package/package.json

@@ -37,6 +37,6 @@
   "module": "./index.esm.js",
   "main": "./index.cjs.js",
   "types": "./index.esm.d.ts",
-  "version": "2.0.0-beta.132",
+  "version": "2.0.0-beta.133",
   "dependencies": {}
 }

package/swc/swcCreateTransform.d.ts

@@ -1,5 +1,11 @@
 export type SwcTransform<LibName extends string> = Record<`${LibName}/?(((\\w*)?/?)*)`, {
     transform: `${LibName}/{{ matches.[1] }}/{{member}}`;
 }>;
+/**
+ * @category swc
+ * @param name e.g. `@myorg/mylib` or `@/myprojectlib`
+ * @param flat Pass `true` for packages where all consumable exports are at the
+ * root level (no exports from nested folders)
+ */
 export declare function swcCreateTransform<T extends string>(name: T, _flat?: boolean): SwcTransform<T>;
 export default swcCreateTransform;

package/swc/swcCreateTransforms.d.ts

@@ -3,5 +3,11 @@ import { type SwcTransform } from "./swcCreateTransform";
 export type SwcTransforms<Names extends string, Prefix extends string> = FlatObjectFirstLevel<{
     [N in Names]: SwcTransform<`${Prefix}${N}`>;
 }>;
+/**
+ * @see https://www.zhoulujun.net/nextjs/advanced-features/compiler.html#modularize-imports
+ *
+ * @category tooling
+ * @category swc
+ */
 export declare const swcCreateTransforms: <TLibs extends readonly string[], TScope extends string>(libs: TLibs, scope?: TScope) => FlatObjectFirstLevel<{ [N in TLibs[number]]: SwcTransform<`${TScope extends string ? `${TScope}/` : ""}${N}`>; }>;
 export default swcCreateTransforms;

package/swc/swcTransformsKoine.d.ts

@@ -1,3 +1,9 @@
+/**
+ * @see https://www.zhoulujun.net/nextjs/advanced-features/compiler.html#modularize-imports
+ *
+ * @category tooling
+ * @category swc
+ */
 export declare const swcTransformsKoine: {
     "@koine/api/?(((\\w*)?/?)*)": {
         transform: "@koine/api/{{ matches.[1] }}/{{member}}";