util.md

@wholebuzz/fs / Exports / util

Module: util

Table of contents

Interfaces

• Logger
• ReadableFileOptions
• ReadableFileSpec
• Shard
• WritableFileOptions

Variables

• logger
• shardRegex
• shardedRegex
• zlib

Functions

• allShardsFilename
• isShardFilename
• isShardedFilename
• lastItem
• lastItemOrNull
• md5
• openReadableFileSet
• openReadableFiles
• openWritableFiles
• readShardFilenames
• shardIndex
• shardIndexOfFilename
• shardMatchText
• shardedFilename
• shardedFilenames
• take
• waitForCompleteShardedInput

Variables

logger

• Const logger: Logger

Defined in: src/util.ts:18

---

shardRegex

• Const shardRegex: RegExp

Defined in: src/util.ts:59

---

shardedRegex

• Const shardedRegex: RegExp

Defined in: src/util.ts:58

---

zlib

• Const zlib: any

Defined in: src/util.ts:6

Functions

allShardsFilename

▸ allShardsFilename(name: string): string

Parameters

Name	Type
name	string

Returns: string

Defined in: src/util.ts:66

---

isShardFilename

▸ Const isShardFilename(name: string): number

Parameters

Name	Type
name	string

Returns: number

Defined in: src/util.ts:61

---

isShardedFilename

▸ Const isShardedFilename(name: string): undefined | number

Parameters

Name	Type
name	string

Returns: undefined | number

Defined in: src/util.ts:60

---

lastItem

▸ Const lastItem<X>(x: X[]): X

Type parameters

Name
X

Parameters

Name	Type
x	X[]

Returns: X

Defined in: src/util.ts:7

---

lastItemOrNull

▸ Const lastItemOrNull<X>(x: X[]): null | X

Type parameters

Name
X

Parameters

Name	Type
x	X[]

Returns: null | X

Defined in: src/util.ts:8

---

md5

▸ Const md5(x: string): string

Parameters

Name	Type
x	string

Returns: string

Defined in: src/util.ts:10

---

openReadableFileSet

▸ openReadableFileSet(fileSystem: FileSystem, fileNames: ReadableFileSpec[] | Record<string, ReadableFileSpec>): Promise<Record<string, ReadableStreamTree[]>>

Parameters

Name	Type
fileSystem	FileSystem
fileNames	ReadableFileSpec[] | Record<string, ReadableFileSpec>

Returns: Promise<Record<string, ReadableStreamTree[]>>

Defined in: src/util.ts:161

---

openReadableFiles

▸ openReadableFiles(fileSystem: FileSystem, url: string, options?: ReadableFileOptions): Promise<ReadableStreamTree[]>

Parameters

Name	Type
fileSystem	FileSystem
url	string
options?	ReadableFileOptions

Returns: Promise<ReadableStreamTree[]>

Defined in: src/util.ts:174

---

openWritableFiles

▸ openWritableFiles(fileSystem: FileSystem, url: string, options?: WritableFileOptions): Promise<WritableStreamTree[]>

Parameters

Name	Type
fileSystem	FileSystem
url	string
options?	WritableFileOptions

Returns: Promise<WritableStreamTree[]>

Defined in: src/util.ts:189

---

readShardFilenames

▸ readShardFilenames(fileSystem: FileSystem, url: string): Promise<{ entries: DirectoryEntry[] ; numShards: number }>

Parameters

Name	Type
fileSystem	FileSystem
url	string

Returns: Promise<{ entries: DirectoryEntry[] ; numShards: number }>

Defined in: src/util.ts:97

---

shardIndex

▸ Const shardIndex(text: string, modulus: number, shardFunction?: (key: string) => string): number

Parameters

Name	Type
text	string
modulus	number
shardFunction?	(key: string) => string

Returns: number

Defined in: src/util.ts:46

---

shardIndexOfFilename

▸ Const shardIndexOfFilename(name: string): number

Parameters

Name	Type
name	string

Returns: number

Defined in: src/util.ts:63

---

shardMatchText

▸ Const shardMatchText(text: string, shard: Shard, shardFunction?: (key: string) => string): boolean

Parameters

Name	Type
text	string
shard	Shard
shardFunction?	(key: string) => string

Returns: boolean

Defined in: src/util.ts:52

---

shardedFilename

▸ Const shardedFilename(name: string, shard: Shard): string

Parameters

Name	Type
name	string
shard	Shard

Returns: string

Defined in: src/util.ts:73

---

shardedFilenames

▸ Const shardedFilenames(name: string, shards: number, filter?: (index: number) => boolean): string[]

Parameters

Name	Type
name	string
shards	number
filter?	(index: number) => boolean

Returns: string[]

Defined in: src/util.ts:87

---

take

▸ Const take<X, Y>(x: X, f: (x: X) => Y): Y

Type parameters

Name
X
Y

Parameters

Name	Type
x	X
f	(x: X) => Y

Returns: Y

Defined in: src/util.ts:9

---

waitForCompleteShardedInput

▸ waitForCompleteShardedInput(fileSystem: FileSystem, url: string, args: { delay?: (trys: number) => number ; maxTrys?: number ; shards?: number }): Promise<void>

Parameters

Name	Type
fileSystem	FileSystem
url	string
args	object
args.delay?	(trys: number) => number
args.maxTrys?	number
args.shards?	number

Returns: Promise<void>

Defined in: src/util.ts:139