aboutsummaryrefslogtreecommitdiff
path: root/types
diff options
context:
space:
mode:
Diffstat (limited to 'types')
-rw-r--r--types/bun/bun.d.ts17
1 files changed, 17 insertions, 0 deletions
diff --git a/types/bun/bun.d.ts b/types/bun/bun.d.ts
index 2ce763b91..2784ace5b 100644
--- a/types/bun/bun.d.ts
+++ b/types/bun/bun.d.ts
@@ -1,3 +1,20 @@
+/**
+ *
+ * Bun.js runtime APIs
+ *
+ * @example
+ *
+ * ```js
+ * import {file} from 'bun';
+ *
+ * // Log the file to the console
+ * const input = await file('/path/to/file.txt').text();
+ * console.log(input);
+ * ```
+ *
+ * This module aliases `globalThis.Bun`.
+ *
+ */
declare module "bun" {
/**
* Start a fast HTTP server.