bun-types 1.0.36 → 1.1.0

package/bun.d.ts

@@ -43,7 +43,7 @@ declare module "bun" {
 	 *
 	 * @param {string} command The name of the executable or script
 	 * @param {string} options.PATH Overrides the PATH environment variable
-	 * @param {string} options.cwd Limits the search to a particular directory in which to searc
+	 * @param {string} options.cwd When given a relative path, use this path to join it.
 	 */
 	function which(
 		command: string,
@@ -280,12 +280,16 @@ declare module "bun" {
 		blob(): Promise<Blob>;
 
 		/**
-		 * Configure the shell to not throw an exception on non-zero exit codes.
+		 * Configure the shell to not throw an exception on non-zero exit codes. Throwing can be re-enabled with `.throws(true)`.
+		 *
+		 * By default, the shell with throw an exception on commands which return non-zero exit codes.
 		 */
 		nothrow(): this;
 
 		/**
 		 * Configure whether or not the shell should throw an exception on non-zero exit codes.
+		 *
+		 * By default, this is configured to `true`.
 		 */
 		throws(shouldThrow: boolean): this;
 	}

package/globals.d.ts

@@ -1874,21 +1874,10 @@ declare global {
 		 * ```
 		 */
 		readonly env: NodeJS.ProcessEnv;
-		/**
-		 * Resolve a module ID the same as if you imported it
-		 *
-		 * On failure, throws a `ResolveMessage`
-		 */
-		resolve(moduleId: string): Promise<string>;
-		/**
-		 * Resolve a `moduleId` as though it were imported from `parent`
-		 *
-		 * On failure, throws a `ResolveMessage`
-		 */
-		// tslint:disable-next-line:unified-signatures
-		resolve(moduleId: string, parent: string): Promise<string>;
 
 		/**
+		 * @deprecated Use `require.resolve` or `Bun.resolveSync(moduleId, path.dirname(parent))` instead
+		 *
 		 * Resolve a module ID the same as if you imported it
 		 *
 		 * The `parent` argument is optional, and defaults to the current module's path.
@@ -1896,17 +1885,12 @@ declare global {
 		resolveSync(moduleId: string, parent?: string): string;
 
 		/**
-		 * Load a CommonJS module
-		 *
-		 * Internally, this is a synchronous version of ESModule's `import()`, with extra code for handling:
-		 * - CommonJS modules
-		 * - *.node files
-		 * - *.json files
+		 * Load a CommonJS module within an ES Module. Bun's transpiler rewrites all
+		 * calls to `require` with `import.meta.require` when transpiling ES Modules
+		 * for the runtime.
 		 *
-		 * Warning: **This API is not stable** and may change in the future. Use at your
-		 * own risk. Usually, you should use `require` instead and Bun's transpiler
-		 * will automatically rewrite your code to use `import.meta.require` if
-		 * relevant.
+		 * Warning: **This API is not stable** and may change or be removed in the
+		 * future. Use at your own risk.
 		 */
 		require: NodeJS.Require;
 
@@ -1930,17 +1914,15 @@ declare global {
 		readonly main: boolean;
 
 		/** Alias of `import.meta.dir`. Exists for Node.js compatibility */
-		dirname: string;
+		readonly dirname: string;
 
 		/** Alias of `import.meta.path`. Exists for Node.js compatibility */
-		filename: string;
+		readonly filename: string;
 	}
 
 	/**
 	 * NodeJS-style `require` function
 	 *
-	 * Internally, uses `import.meta.require`
-	 *
 	 * @param moduleId - The module ID to resolve
 	 */
 	var require: NodeJS.Require;

package/package.json

@@ -1,5 +1,5 @@
 {
-  "version": "1.0.36",
+  "version": "1.1.0",
   "name": "bun-types",
   "license": "MIT",
   "main": "",

package/test.d.ts

@@ -204,12 +204,17 @@ declare module "bun:test" {
 		 * @param condition if these tests should be skipped
 		 */
 		skipIf(condition: boolean): (label: string, fn: () => void) => void;
+		/**
+		 * Marks this group of tests as to be written or to be fixed, if `condition` is true.
+		 *
+		 * @param condition if these tests should be skipped
+		 */
+		todoIf(condition: boolean): (label: string, fn: () => void) => void;
 		/**
 		 * Returns a function that runs for each item in `table`.
 		 *
 		 * @param table Array of Arrays with the arguments that are passed into the test fn for each row.
 		 */
-
 		each<T extends Readonly<[any, ...any[]]>>(
 			table: readonly T[],
 		): (
@@ -457,6 +462,20 @@ declare module "bun:test" {
 				| ((done: (err?: unknown) => void) => void),
 			options?: number | TestOptions,
 		) => void;
+		/**
+		 * Marks this test as to be written or to be fixed, if `condition` is true.
+		 *
+		 * @param condition if the test should be marked TODO
+		 */
+		todoIf(
+			condition: boolean,
+		): (
+			label: string,
+			fn:
+				| (() => void | Promise<unknown>)
+				| ((done: (err?: unknown) => void) => void),
+			options?: number | TestOptions,
+		) => void;
 		/**
 		 * Returns a function that runs for each item in `table`.
 		 *