Skip to main content

Class: MixedFile

Methods

exists#

â–¸ exists(): boolean

Check if File Exists

Returns: boolean


readContent#

â–¸ readContent(options?: { encoding?: null ; flag?: string }): Buffer

Read file contents

Parameters:#

NameType
options?object
options.encoding?null
options.flag?string

Returns: Buffer


toJson#

â–¸ toJson<T>(encoding?: BufferEncoding): T

Parse file as json

Type parameters:#

NameDefault
Tany

Parameters:#

NameTypeDefault value
encodingBufferEncoding'utf-8'

Returns: T


toYaml#

â–¸ toYaml<T>(encoding?: BufferEncoding): T

Parse file as yaml

Type parameters:#

NameDefault
Tany

Parameters:#

NameTypeDefault value
encodingBufferEncoding'utf-8'

Returns: T


writeContet#

â–¸ writeContet(content: string | ArrayBufferView): Promise<void>

Write content to file

Parameters:#

NameType
contentstring | ArrayBufferView

Returns: Promise<void>