json.md

@wholebuzz/fs / Exports / json

Module: json

Table of contents

Variables

• JSONStream

Functions

• newJSONLinesFormatter
• newJSONLinesParser
• parseJSON
• parseJSONLines
• pipeJSONFormatter
• pipeJSONLinesFormatter
• pipeJSONLinesParser
• pipeJSONParser
• readJSON
• readJSONHashed
• readJSONLines
• serializeJSON
• serializeJSONLines
• writeJSON
• writeJSONLines
• writeShardedJSONLines

Variables

JSONStream

• Const JSONStream: any

Defined in: src/json.ts:11

Functions

newJSONLinesFormatter

▸ Const newJSONLinesFormatter(): Transform

Returns: Transform

Defined in: src/json.ts:146

---

newJSONLinesParser

▸ Const newJSONLinesParser(): ThroughStream

Returns: ThroughStream

Defined in: src/json.ts:147

---

parseJSON

▸ parseJSON(stream: ReadableStreamTree): Promise<unknown>

Parses JSON object from [[stream]]. Used to implement readJSON.

Parameters

Name	Type	Description
stream	ReadableStreamTree	The stream to read a JSON object from.

Returns: Promise<unknown>

Defined in: src/json.ts:72

---

parseJSONLines

▸ parseJSONLines(stream: ReadableStreamTree): Promise<unknown[]>

Parses JSON object from [[stream]]. Used to implement readJSON.

Parameters

Name	Type	Description
stream	ReadableStreamTree	The stream to read a JSON object from.

Returns: Promise<unknown[]>

Defined in: src/json.ts:80

---

pipeJSONFormatter

▸ pipeJSONFormatter(stream: WritableStreamTree, isArray: boolean): WritableStreamTree

Create JSON formatter stream.

Parameters

Name	Type	Description
stream	WritableStreamTree	-
isArray	boolean	Accept array objects or property tuples.

Returns: WritableStreamTree

Defined in: src/json.ts:127

---

pipeJSONLinesFormatter

▸ pipeJSONLinesFormatter(stream: WritableStreamTree): WritableStreamTree

Create JSON-lines formatter stream.

Parameters

Name	Type
stream	WritableStreamTree

Returns: WritableStreamTree

Defined in: src/json.ts:142

---

pipeJSONLinesParser

▸ pipeJSONLinesParser(stream: ReadableStreamTree): ReadableStreamTree

Create JSON parser stream.

Parameters

Name	Type
stream	ReadableStreamTree

Returns: ReadableStreamTree

Defined in: src/json.ts:119

---

pipeJSONParser

▸ pipeJSONParser(stream: ReadableStreamTree, isArray: boolean): ReadableStreamTree

Create JSON parser stream.

Parameters

Name	Type
stream	ReadableStreamTree
isArray	boolean

Returns: ReadableStreamTree

Defined in: src/json.ts:110

---

readJSON

▸ readJSON(fileSystem: FileSystem, url: string): Promise<unknown>

Reads a serialized JSON object or array from a file.

Parameters

Name	Type	Description
fileSystem	FileSystem	-
url	string	The URL of the file to parse a JSON object or array from.

Returns: Promise<unknown>

Defined in: src/json.ts:17

---

readJSONHashed

▸ readJSONHashed(fileSystem: FileSystem, url: string): Promise<[unknown, null | string]>

Reads a serialized JSON object from a file, and also hashes the file.

Parameters

Name	Type	Description
fileSystem	FileSystem	-
url	string	The URL of the file to parse a JSON object from.

Returns: Promise<[unknown, null | string]>

Defined in: src/json.ts:25

---

readJSONLines

▸ readJSONLines(fileSystem: FileSystem, url: string): Promise<unknown[]>

Reads a serialized JSON-lines array from a file.

Parameters

Name	Type	Description
fileSystem	FileSystem	-
url	string	The URL of the file to parse a JSON object or array from.

Returns: Promise<unknown[]>

Defined in: src/json.ts:35

---

serializeJSON

▸ serializeJSON(stream: WritableStreamTree, obj: object | any[]): Promise<boolean>

Serializes JSON object to [[stream]]. Used to implement writeJSON.

Parameters

Name	Type	Description
stream	WritableStreamTree	The stream to write a JSON object to.
obj	object | any[]	-

Returns: Promise<boolean>

Defined in: src/json.ts:88

---

serializeJSONLines

▸ serializeJSONLines(stream: WritableStreamTree, obj: any[]): Promise<boolean>

Serializes JSON object to [[stream]]. Used to implement writeJSONLines.

Parameters

Name	Type	Description
stream	WritableStreamTree	The stream to write a JSON object to.
obj	any[]	-

Returns: Promise<boolean>

Defined in: src/json.ts:103

---

writeJSON

▸ writeJSON(fileSystem: FileSystem, url: string, value: object | any[]): Promise<boolean>

Serializes object or array to a JSON file.

Parameters

Name	Type	Description
fileSystem	FileSystem	-
url	string	The URL of the file to serialize a JSON object or array to.
value	object | any[]	The object or array to serialize.

Returns: Promise<boolean>

Defined in: src/json.ts:44

---

writeJSONLines

▸ writeJSONLines(fileSystem: FileSystem, url: string, obj: object[]): Promise<boolean>

Serializes array to a JSON Lines file.

Parameters

Name	Type	Description
fileSystem	FileSystem	-
url	string	The URL of the file to serialize a JSON array to.
obj	object[]	-

Returns: Promise<boolean>

Defined in: src/json.ts:53

---

writeShardedJSONLines

▸ writeShardedJSONLines(fileSystem: FileSystem, url: string, obj: object[], shards: number, shardFunction?: (x: object, modulus: number) => number): Promise<boolean>

Parameters

Name	Type
fileSystem	FileSystem
url	string
obj	object[]
shards	number
shardFunction	(x: object, modulus: number) => number

Returns: Promise<boolean>

Defined in: src/json.ts:57