@noir-lang/noir_wasm 0.23.0-682b159.nightly → 0.23.0-746b0c7.nightly

package/dist/types/src/index.d.cts

@@ -3,6 +3,36 @@ import { createNodejsFileManager } from './noir/file-manager/nodejs-file-manager
 import { LogFn } from './utils';
 import { CompilationResult } from './types/noir_artifact';
 import { inflateDebugSymbols } from './noir/debug';
+/**
+ * Compiles a Noir project
+ *
+ * @param fileManager - The file manager to use
+ * @param projectPath - The path to the project inside the file manager. Defaults to the root of the file manager
+ * @param logFn - A logging function. If not provided, console.log will be used
+ * @param debugLogFn - A debug logging function. If not provided, logFn will be used
+ *
+ * @example
+ * ```typescript
+ * // Node.js
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager('/');
+ * for (const path of files) {
+ *   await fm.writeFile(path, await getFileAsStream(path));
+ * }
+ * const myCompiledCode = await compile(fm);
+ * ```
+ */
 declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
 declare const createFileManager: typeof createNodejsFileManager;
 export { compile, createFileManager, inflateDebugSymbols, CompilationResult };

package/dist/types/src/index.d.mts

@@ -3,6 +3,36 @@ import { createNodejsFileManager } from './noir/file-manager/nodejs-file-manager
 import { LogFn } from './utils';
 import { CompilationResult } from './types/noir_artifact';
 import { inflateDebugSymbols } from './noir/debug';
+/**
+ * Compiles a Noir project
+ *
+ * @param fileManager - The file manager to use
+ * @param projectPath - The path to the project inside the file manager. Defaults to the root of the file manager
+ * @param logFn - A logging function. If not provided, console.log will be used
+ * @param debugLogFn - A debug logging function. If not provided, logFn will be used
+ *
+ * @example
+ * ```typescript
+ * // Node.js
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager(myProjectPath);
+ * const myCompiledCode = await compile(fm);
+ * ```
+ *
+ * ```typescript
+ * // Browser
+ *
+ * import { compile, createFileManager } from '@noir-lang/noir_wasm';
+ *
+ * const fm = createFileManager('/');
+ * for (const path of files) {
+ *   await fm.writeFile(path, await getFileAsStream(path));
+ * }
+ * const myCompiledCode = await compile(fm);
+ * ```
+ */
 declare function compile(fileManager: FileManager, projectPath?: string, logFn?: LogFn, debugLogFn?: LogFn): Promise<CompilationResult>;
 declare const createFileManager: typeof createNodejsFileManager;
 export { compile, createFileManager, inflateDebugSymbols, CompilationResult };

package/dist/types/src/noir/debug.d.ts

@@ -1,2 +1,5 @@
-/** Decompresses and decodes the debug symbols */
+/**
+ * Decompresses and decodes the debug symbols
+ * @param debugSymbols - The base64 encoded debug symbols
+ */
 export declare function inflateDebugSymbols(debugSymbols: string): any;

package/dist/types/src/noir/file-manager/nodejs-file-manager.d.ts

@@ -1,7 +1,8 @@
 import { FileManager } from './file-manager';
 export declare function readdirRecursive(dir: string): Promise<string[]>;
 /**
- * Creates a new FileManager instance based on nodejs fs
- * @param dataDir - where to store files
+ * Creates a new FileManager instance based on fs in node and memfs in the browser (via webpack alias)
+ *
+ * @param dataDir - root of the file system
  */
 export declare function createNodejsFileManager(dataDir: string): FileManager;