# Module: shared/build-time/utilities

@makerx/repository-website-generator / shared/build-time/utilities

Table of contents

Functions

Functions

asyncGeneratorToArray

asyncGeneratorToArray<T>(asyncIterator): Promise<T[]>

Type parameters

Name
T

Parameters

NameType
asyncIteratorAsyncGenerator<T, any, unknown>

Returns

Promise<T[]>

Defined in

shared/build-time/utilities.ts:4


getFilesRecursive

getFilesRecursive(dirPath, isRelative?): AsyncGenerator<string>

Parameters

NameTypeDefault value
dirPathstringundefined
isRelativebooleantrue

Returns

AsyncGenerator<string>

Defined in

shared/build-time/utilities.ts:10


getMarkdownFileNames

getMarkdownFileNames(relativePath): Promise<string[]>

Parameters

NameType
relativePathstring

Returns

Promise<string[]>

Defined in

shared/build-time/utilities.ts:26


readFile

readFile(relativePath, fileName): Buffer

Parameters

NameType
relativePathstring
fileNamestring

Returns

Buffer

Defined in

shared/build-time/utilities.ts:30