# @wrote/read
[](https://npmjs.org/package/@wrote/read)
`@wrote/read` is a package to read a file as a string or a Buffer.
```sh
yarn add -E @wrote/read
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`async read(path: string): string`](#async-readpath-string-string)
- [`async readBuffer(path: string): Buffer`](#async-readbufferpath-string-buffer)
- [Copyright](#copyright)
## API
The package is available by importing its default function `read`, and named function `readBuffer`:
```js
import read, { readBuffer } from '@wrote/read'
```
## `async read(`
`path: string,`
`): string`
Read the file as a string.
```js
/* yarn example/ */
import read from '@wrote/read'
(async () => {
const res = await read('example/data.txt')
console.log(res)
})()
```
```
Hello World
```
## `async readBuffer(`
`path: string,`
`): Buffer`
Read the file as a Buffer.
```js
/* yarn example/ */
import { readBuffer } from '@wrote/read'
(async () => {
const res = await readBuffer('example/data.txt')
console.log(res)
})()
```
```
```
## Copyright
