bun-types 1.1.28-canary.20240913T140515 → 1.1.28-canary.20240915T140517

package/ffi.d.ts

@@ -601,6 +601,66 @@ declare module "bun:ffi" {
 		symbols: Fns,
 	): Library<Fns>;
 
+	/**
+	 * **Experimental:** Compile ISO C11 source code using TinyCC, and make {@link symbols} available as functions to JavaScript.
+	 *
+	 * @param options
+	 * @returns Library<Fns>
+	 *
+	 * @example
+	 * ## Hello, World!
+	 *
+	 * JavaScript:
+	 * ```js
+	 * import { cc } from "bun:ffi";
+	 * import hello from "./hello.c" with {type: "file"};
+	 * const {symbols: {hello}} = cc({
+	 *   source: hello,
+	 *   symbols: {
+	 *     hello: {
+	 *       returns: "cstring",
+	 *       args: [],
+	 *     },
+	 *   },
+	 * });
+	 * // "Hello, World!"
+	 * console.log(hello());
+	 * ```
+	 *
+	 * `./hello.c`:
+	 * ```c
+	 * #include <stdio.h>
+	 * const char* hello() {
+	 *   return "Hello, World!";
+	 * }
+	 * ```
+	 */
+	function cc<Fns extends Record<string, FFIFunction>>(options: {
+		/**
+		 * File path to an ISO C11 source file to compile and link
+		 */
+		source: string | import("bun").BunFile | URL;
+
+		/**
+		 * Library names to link against
+		 *
+		 * Equivalent to `-l` option in gcc/clang.
+		 */
+		library?: string[] | string;
+
+		/**
+		 * Include directories to pass to the compiler
+		 *
+		 * Equivalent to `-I` option in gcc/clang.
+		 */
+		include?: string[] | string;
+
+		/**
+		 * Map of symbols to load where the key is the symbol name and the value is the {@link FFIFunction}
+		 */
+		symbols: Fns;
+	}): Library<Fns>;
+
 	/**
 	 * Turn a native library's function pointer into a JavaScript function
 	 *

package/package.json

@@ -1,5 +1,5 @@
 {
-	"version": "1.1.28-canary.20240913T140515",
+	"version": "1.1.28-canary.20240915T140517",
 	"name": "bun-types",
 	"license": "MIT",
 	"main": "",