aboutsummaryrefslogtreecommitdiff
path: root/docs/guides/write-file/basic.md
blob: 66f180a40be6c893c103bd44bd9afcaab6008557 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
---
name: Write a string to a file
---

This code snippet writes a string to disk at a particular _absolute path_.

It uses the fast [`Bun.write()`](/docs/api/file-io#writing-files-bun-write) API to efficiently write data to disk. The first argument is a _destination_; the second is the _data_ to write.

```ts
const path = "/path/to/file.txt";
await Bun.write(path, "Lorem ipsum");
```

---

Any relative paths will be resolved relative to the project root (the nearest directory containing a `package.json` file).

```ts
const path = "./file.txt";
await Bun.write(path, "Lorem ipsum");
```

---

You can pass a `BunFile` as the destination. `Bun.write()` will write the data to its associated path.

```ts
const path = Bun.file("./file.txt");
await Bun.write(path, "Lorem ipsum");
```

---

`Bun.write()` returns the number of bytes written to disk.

```ts
const path = "./file.txt";
const bytes = await Bun.write(path, "Lorem ipsum");
// => 11
```

---

See [Docs > API > File I/O](/docs/api/file-io#writing-files-bun-write) for complete documentation of `Bun.write()`.
.com/avatar/764ea52180f7f5236744034dd5e1a3c0?s=13&d=retro' width='13' height='13' alt='Gravatar' /> Jarred Sumner 1-1/+10 2021-09-30Fix dead-code elimination edgecase with call expressionsGravatar Jarred Sumner 1-6/+9 2021-09-30Fix edgecase with parsing .envGravatar Jarred Sumner 1-1/+1 2021-09-30Support remapping macro pathsGravatar Jarred Sumner 14-91/+392 2021-09-30Fix all the compile errorsGravatar Jarred Sumner 3-133/+210 2021-09-30Wire up macro-injected imports and move some structs above the gigantic parse...Gravatar Jarred Sumner 3-430/+538 2021-09-30flatten fragmentsGravatar Jarred Sumner 1-3/+27 2021-09-29Most of the code & API changes necessary for supporting Relay (GraphQL)Gravatar Jarred Sumner 5-14/+497 2021-09-27CleanupGravatar Jarred Sumner 3-2/+5 2021-09-27RemoveGravatar Jarred Sumner 1-78/+0 2021-09-27Fix up examplesbun-v0.0.26Gravatar Jarred Sumner 6-7/+156 2021-09-27()Gravatar Jarred Sumner 1-1/+1