@wrote/read

@wrote/read is a package to read a file as a string or a Buffer.

yarn add -E @wrote/read

Table Of Contents

• Table Of Contents
• API
• async read(path: string): string
• async readBuffer(path: string): Buffer
• Copyright

API

The package is available by importing its default function read, and named function readBuffer:

import read, { readBuffer } from '@wrote/read'

async read(
  path: string,
): string

Read the file as a string.

/* 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.

/* yarn example/ */
import { readBuffer } from '@wrote/read'

(async () => {
  const res = await readBuffer('example/data.txt')
  console.log(res)
})()

<Buffer 48 65 6c 6c 6f 20 57 6f 72 6c 64>

Copyright

	© Art Deco for Wrote 2019			Tech Nation Visa Sucks

10 April 2019

1.0.4

• [deps] Update catchment and unlock dependencies.

2 April 2019

1.0.3

• [deps] Update catchment.

15 January 2019

1.0.2

• [deps] Update catchment.

14 January 2019

1.0.1

• [package] Add the "module" field.

26 September 2018

1.0.0

• Create @wrote/read with [mnp][https://mnpjs.org]
• [repository]: src, test