Class: FileSource

dg.FileSource

Constructors

constructor

• new FileSource(root?)

Parameters

Name	Type	Default value
root	string	''

Defined in

src/dapi.ts:964

Properties

root

• Private Readonly root: string

Defined in

src/dapi.ts:963

Methods

delete

▸ delete(file): Promise<void>

Deletes a file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type
file	string | FileInfo

Returns

Promise<void>

Defined in

src/dapi.ts:990

---

exists

▸ exists(file): Promise<boolean>

Checks if a file exists. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type
file	string | FileInfo

Returns

Promise<boolean>

Defined in

src/dapi.ts:972

---

list

▸ list(file, recursive?, searchPattern?): Promise<FileInfo[]>

Lists files according to a search pattern. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type	Default value	Description
file	string | FileInfo	undefined	folder
recursive	boolean	false	whether to search in folders recursively
searchPattern	null | string	null	search pattern, such as part of a filename or extension, e.g., "filename-prefix" and "csv"

Returns

Promise<FileInfo[]>

Defined in

src/dapi.ts:1026

---

move

▸ move(files, newPath): Promise<void>

Moves a file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type
files	string[] | FileInfo[]
newPath	string

Returns

Promise<void>

Defined in

src/dapi.ts:1000

---

readAsBytes

▸ readAsBytes(file): Promise<Uint8Array>

Reads a file as bytes. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type
file	string | FileInfo

Returns

Promise<Uint8Array>

Defined in

src/dapi.ts:1048

---

readAsText

▸ readAsText(file): Promise<string>

Reads a file as string. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type
file	string | FileInfo

Returns

Promise<string>

Defined in

src/dapi.ts:1035

---

readBinaryDataFrames

▸ readBinaryDataFrames(file): Promise<DataFrame[]>

Reads a d42 file as a list of dataframes.

Parameters

Name	Type
file	string | FileInfo

Returns

Promise<DataFrame[]>

Defined in

src/dapi.ts:1056

---

readCsv

▸ readCsv(file): Promise<DataFrame>

Parameters

Name	Type
file	string | FileInfo

Returns

Promise<DataFrame>

Defined in

src/dapi.ts:1040

---

rename

▸ rename(file, newName): Promise<void>

Renames a file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type
file	string | FileInfo
newName	string

Returns

Promise<void>

Defined in

src/dapi.ts:1013

---

setRoot

▸ Private setRoot(file): string

Parameters

Name	Type
file	string | FileInfo

Returns

string

Defined in

src/dapi.ts:977

---

write

▸ write(file, blob): Promise<void>

Writes a file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type
file	string | FileInfo
blob	number[]

Returns

Promise<void>

Defined in

src/dapi.ts:1074

---

writeAsText

▸ writeAsText(file, data): Promise<void>

Writes a text file. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Name	Type
file	string | FileInfo
data	string

Returns

Promise<void>

Defined in

src/dapi.ts:1083

---

writeBinaryDataFrames

▸ writeBinaryDataFrames(file, dataFrames): Promise<void>

Writes a list of dataframes as a d42 file.

Parameters

Name	Type
file	string | FileInfo
dataFrames	DataFrame[]

Returns

Promise<void>

Defined in

src/dapi.ts:1064