FileSource

Constructors

new FileSource()

new FileSource(root): FileSource

Parameters

Parameter	Type	Default value
root	string	''

Returns

FileSource

Source

src/dapi.ts:999

Properties

Property	Modifier	Type
root	private	string

Methods

delete()

delete(file): Promise<void>

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

Parameters

Parameter	Type	Description
file	string | FileInfo

Returns

Promise<void>

Source

src/dapi.ts:1025

---

exists()

exists(file): Promise<boolean>

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

Parameters

Parameter	Type	Description
file	string | FileInfo

Returns

Promise<boolean>

Source

src/dapi.ts:1007

---

list()

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

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

Parameters

Parameter	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[]>

Source

src/dapi.ts:1061

---

move()

move(files, newPath): Promise<void>

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

Parameters

Parameter	Type	Description
files	string[] | FileInfo[]
newPath	string

Returns

Promise<void>

Source

src/dapi.ts:1035

---

readAsBytes()

readAsBytes(file): Promise<Uint8Array>

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

Parameters

Parameter	Type	Description
file	string | FileInfo

Returns

Promise<Uint8Array>

Source

src/dapi.ts:1088

---

readAsText()

readAsText(file): Promise<string>

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

Parameters

Parameter	Type	Description
file	string | FileInfo

Returns

Promise<string>

Source

src/dapi.ts:1070

---

readBinaryDataFrames()

readBinaryDataFrames(file): Promise <DataFrame[]>

Reads a d42 file as a list of dataframes.

Parameters

Parameter	Type	Description
file	string | FileInfo

Returns

Promise <DataFrame[]>

Source

src/dapi.ts:1096

---

readCsv()

readCsv(file, options?): Promise <DataFrame>

Reads CSV as DataFrame. Sample: https://public.datagrok.ai/js/samples/dapi/files

Parameters

Parameter	Type	Description
file	string | FileInfo
options?	CsvImportOptions

Returns

Promise <DataFrame>

Source

src/dapi.ts:1080

---

rename()

rename(file, newName): Promise<void>

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

Parameters

Parameter	Type	Description
file	string | FileInfo
newName	string

Returns

Promise<void>

Source

src/dapi.ts:1048

---

setRoot()

private setRoot(file): string

Parameters

Parameter	Type
file	string | FileInfo

Returns

string

Source

src/dapi.ts:1012

---

write()

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

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

Parameters

Parameter	Type	Description
file	string | FileInfo
blob?	number[]

Returns

Promise<void>

Source

src/dapi.ts:1114

---

writeAsText()

writeAsText(file, data): Promise<void>

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

Parameters

Parameter	Type	Description
file	string | FileInfo
data	string

Returns

Promise<void>

Source

src/dapi.ts:1125

---

writeBinaryDataFrames()

writeBinaryDataFrames(file, dataFrames): Promise<void>

Writes a list of dataframes as a d42 file.

Parameters

Parameter	Type	Description
file	string | FileInfo
dataFrames	DataFrame[]

Returns

Promise<void>

Source

src/dapi.ts:1104