- Preparing search index...
- The search index is not available
tonstorage-cli
Constructors
constructor
- new TonstorageCLI(options): TonstorageCLI
-
Parameters
-
options: {
bin: string;
database: string;
host: string;
timeout: number;
}
-
bin: string
-
database: string
-
host: string
-
timeout: number
Properties
Private database
database: string
Private host
host: string
Private timeout
timeout: number
Methods
addByHash
- addByHash(bagId, options?): Promise<response>
-
Parameters
-
bagId: string
-
Optional options: {
download?: boolean;
partialFiles?: string[];
rootDir?: string;
upload?: boolean;
}
-
Optional download?: boolean
-
Optional partialFiles?: string[]
-
Optional rootDir?: string
-
Optional upload?: boolean
Returns Promise<response>
addByMeta
- addByMeta(path, options?): Promise<response>
-
Parameters
-
path: string
-
Optional options: {
download?: boolean;
partialFiles?: string[];
rootDir?: string;
upload?: boolean;
}
-
Optional download?: boolean
-
Optional partialFiles?: string[]
-
Optional rootDir?: string
-
Optional upload?: boolean
Returns Promise<response>
closeContract
- closeContract(address): Promise<response>
-
Returns Promise<response>
create
- create(path, options?): Promise<response>
-
Parameters
-
path: string
-
Optional options: {
copy?: boolean;
desc?: string;
upload?: boolean;
}
-
Optional copy?: boolean
-
Optional desc?: string
-
Optional upload?: boolean
Returns Promise<response>
deployProvider
- deployProvider(): Promise<response>
-
Returns Promise<response>
downloadPause
- downloadPause(bagId): Promise<response>
-
Returns Promise<response>
downloadResume
- downloadResume(bagId): Promise<response>
-
Returns Promise<response>
get
- get(bagId): Promise<response>
-
Returns Promise<response>
getMeta
- getMeta(bagId, path): Promise<response>
-
Parameters
-
bagId: string
-
path: string
Returns Promise<response>
getPeers
- getPeers(bagId): Promise<response>
-
Returns Promise<response>
getProviderInfo
- getProviderInfo(options?): Promise<response>
-
Parameters
-
Optional options: {
balances?: boolean;
contracts?: boolean;
}
-
Optional balances?: boolean
-
Optional contracts?: boolean
Returns Promise<response>
getProviderParams
- getProviderParams(providerAddress?): Promise<response>
-
Parameters
-
Optional providerAddress: string
Returns Promise<response>
list
- list(): Promise<response>
-
Returns Promise<response>
Private messageResponse
- messageResponse(cmd, successMessageRegexp, options?): Promise<response>
-
Parameters
-
cmd: string
-
successMessageRegexp: RegExp
-
Optional options: {
timeout?: number;
}
-
Optional timeout?: number
Returns Promise<response>
newContractMessage
- newContractMessage(bagId, queryId, providerAddress): Promise<response>
-
Parameters
-
bagId: string
-
queryId: number
-
providerAddress: string
Returns Promise<response>
priorityAll
- priorityAll(bagId, priority): Promise<response>
-
Parameters
-
bagId: string
-
priority: number
Returns Promise<response>
priorityIdx
- priorityIdx(bagId, fileId, priority): Promise<response>
-
Parameters
-
bagId: string
-
fileId: number
-
priority: number
Returns Promise<response>
priorityName
- priorityName(bagId, name, priority): Promise<response>
-
Parameters
-
bagId: string
-
name: string
-
priority: number
Returns Promise<response>
remove
- remove(bagId, options?): Promise<response>
-
Parameters
-
bagId: string
-
Optional options: {
removeFiles?: boolean;
}
-
Optional removeFiles?: boolean
Returns Promise<response>
Private response
- response(cmd, options?): Promise<response>
-
Parameters
-
cmd: string
-
Optional options: {
timeout?: number;
}
-
Optional timeout?: number
Returns Promise<response>
run
- run(cmd, options?): Promise<{
stderr: string;
stdout: string;
}>
-
Parameters
-
cmd: string
-
Optional options: {
maxBuffer?: number;
timeout?: number;
}
-
Optional maxBuffer?: number
-
Optional timeout?: number
Returns Promise<{
stderr: string;
stdout: string;
}>
sendCoins
- sendCoins(address, amount, options?): Promise<response>
-
Parameters
-
address: string
-
amount: number
-
Optional options: {
message?: string;
}
-
Optional message?: string
Returns Promise<response>
setProviderConfig
- setProviderConfig(maxContracts, maxTotalSize): Promise<response>
-
Parameters
-
maxContracts: number
-
maxTotalSize: number
Returns Promise<response>
setProviderParams
- setProviderParams(accept, rate, maxSpan, minFileSize, maxFileSize): Promise<response>
-
Parameters
-
accept: number
-
rate: number
-
maxSpan: number
-
minFileSize: number
-
maxFileSize: number
Returns Promise<response>
uploadPause
- uploadPause(bagId): Promise<response>
-
Returns Promise<response>
uploadResume
- uploadResume(bagId): Promise<response>
-
Returns Promise<response>
withdraw
- withdraw(address): Promise<response>
-
Returns Promise<response>
withdrawAll
- withdrawAll(): Promise<response>
-
Returns Promise<response>