aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-07-11 15:32:41 -0700
committerGravatar Colin McDonnell <colinmcd94@gmail.com> 2023-07-11 15:32:52 -0700
commit609f81a74614b20a1d49ce1197e1ddfe5aa2736f (patch)
tree41224aeb3ab9c8675231e249ff5647eb1725e9c8
parentfd4c8fb871c12157f64b4d6297614dcc8f571ddd (diff)
downloadbun-609f81a74614b20a1d49ce1197e1ddfe5aa2736f.tar.gz
bun-609f81a74614b20a1d49ce1197e1ddfe5aa2736f.tar.zst
bun-609f81a74614b20a1d49ce1197e1ddfe5aa2736f.zip
Add npmrc note
-rw-r--r--docs/api/file-io.md12
-rw-r--r--docs/install/registries.md4
2 files changed, 14 insertions, 2 deletions
diff --git a/docs/api/file-io.md b/docs/api/file-io.md
index effc57580..be9cf0991 100644
--- a/docs/api/file-io.md
+++ b/docs/api/file-io.md
@@ -285,7 +285,13 @@ interface Bun {
write(
destination: string | number | BunFile | URL,
- input: string | Blob | ArrayBuffer | SharedArrayBuffer | TypedArray | Response,
+ input:
+ | string
+ | Blob
+ | ArrayBuffer
+ | SharedArrayBuffer
+ | TypedArray
+ | Response,
): Promise<number>;
}
@@ -301,7 +307,9 @@ interface BunFile {
}
export interface FileSink {
- write(chunk: string | ArrayBufferView | ArrayBuffer | SharedArrayBuffer): number;
+ write(
+ chunk: string | ArrayBufferView | ArrayBuffer | SharedArrayBuffer,
+ ): number;
flush(): number | Promise<number>;
end(error?: Error): number | Promise<number>;
start(options?: { highWaterMark?: number }): void;
diff --git a/docs/install/registries.md b/docs/install/registries.md
index e4090e3c9..86657ca26 100644
--- a/docs/install/registries.md
+++ b/docs/install/registries.md
@@ -24,3 +24,7 @@ To configure a private registry scoped to a particular organization:
# registry with token
"@myorg3" = { token = "$npm_token", url = "https://registry.myorg.com/" }
```
+
+### `.npmrc`
+
+Bun does not currently read `.npmrc` files. For private registries, migrate your registry configuration to `bunfig.toml` as documented above.