35 Star 97 Fork 2.4K

OpenHarmony / interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
@ohos.fileio.d.ts 54.11 KB
一键复制 编辑 原始数据 按行查看 历史
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667686970717273747576777879808182838485868788899091929394959697989910010110210310410510610710810911011111211311411511611711811912012112212312412512612712812913013113213313413513613713813914014114214314414514614714814915015115215315415515615715815916016116216316416516616716816917017117217317417517617717817918018118218318418518618718818919019119219319419519619719819920020120220320420520620720820921021121221321421521621721821922022122222322422522622722822923023123223323423523623723823924024124224324424524624724824925025125225325425525625725825926026126226326426526626726826927027127227327427527627727827928028128228328428528628728828929029129229329429529629729829930030130230330430530630730830931031131231331431531631731831932032132232332432532632732832933033133233333433533633733833934034134234334434534634734834935035135235335435535635735835936036136236336436536636736836937037137237337437537637737837938038138238338438538638738838939039139239339439539639739839940040140240340440540640740840941041141241341441541641741841942042142242342442542642742842943043143243343443543643743843944044144244344444544644744844945045145245345445545645745845946046146246346446546646746846947047147247347447547647747847948048148248348448548648748848949049149249349449549649749849950050150250350450550650750850951051151251351451551651751851952052152252352452552652752852953053153253353453553653753853954054154254354454554654754854955055155255355455555655755855956056156256356456556656756856957057157257357457557657757857958058158258358458558658758858959059159259359459559659759859960060160260360460560660760860961061161261361461561661761861962062162262362462562662762862963063163263363463563663763863964064164264364464564664764864965065165265365465565665765865966066166266366466566666766866967067167267367467567667767867968068168268368468568668768868969069169269369469569669769869970070170270370470570670770870971071171271371471571671771871972072172272372472572672772872973073173273373473573673773873974074174274374474574674774874975075175275375475575675775875976076176276376476576676776876977077177277377477577677777877978078178278378478578678778878979079179279379479579679779879980080180280380480580680780880981081181281381481581681781881982082182282382482582682782882983083183283383483583683783883984084184284384484584684784884985085185285385485585685785885986086186286386486586686786886987087187287387487587687787887988088188288388488588688788888989089189289389489589689789889990090190290390490590690790890991091191291391491591691791891992092192292392492592692792892993093193293393493593693793893994094194294394494594694794894995095195295395495595695795895996096196296396496596696796896997097197297397497597697797897998098198298398498598698798898999099199299399499599699799899910001001100210031004100510061007100810091010101110121013101410151016101710181019102010211022102310241025102610271028102910301031103210331034103510361037103810391040104110421043104410451046104710481049105010511052105310541055105610571058105910601061106210631064106510661067106810691070107110721073107410751076107710781079108010811082108310841085108610871088108910901091109210931094109510961097109810991100110111021103110411051106110711081109111011111112111311141115111611171118111911201121112211231124112511261127112811291130113111321133113411351136113711381139114011411142114311441145114611471148114911501151115211531154115511561157115811591160116111621163116411651166116711681169117011711172117311741175117611771178117911801181118211831184118511861187118811891190119111921193119411951196119711981199120012011202120312041205120612071208120912101211121212131214121512161217121812191220122112221223122412251226122712281229123012311232123312341235123612371238123912401241124212431244124512461247124812491250125112521253125412551256125712581259126012611262126312641265126612671268126912701271127212731274127512761277127812791280128112821283128412851286128712881289129012911292129312941295129612971298129913001301130213031304130513061307130813091310131113121313131413151316131713181319132013211322132313241325132613271328132913301331133213331334133513361337133813391340134113421343134413451346134713481349135013511352135313541355135613571358135913601361136213631364136513661367136813691370137113721373137413751376137713781379138013811382138313841385138613871388138913901391139213931394139513961397139813991400140114021403140414051406140714081409141014111412141314141415141614171418141914201421142214231424142514261427142814291430143114321433143414351436143714381439144014411442144314441445144614471448144914501451145214531454145514561457145814591460146114621463146414651466146714681469147014711472147314741475147614771478147914801481148214831484148514861487148814891490149114921493149414951496149714981499150015011502150315041505150615071508150915101511151215131514151515161517151815191520152115221523152415251526152715281529153015311532153315341535153615371538153915401541154215431544154515461547154815491550155115521553155415551556155715581559156015611562156315641565156615671568156915701571157215731574157515761577157815791580158115821583158415851586158715881589159015911592159315941595159615971598159916001601160216031604160516061607160816091610161116121613161416151616161716181619162016211622162316241625162616271628162916301631163216331634163516361637163816391640164116421643164416451646164716481649165016511652165316541655165616571658165916601661166216631664166516661667166816691670167116721673167416751676167716781679168016811682168316841685168616871688168916901691169216931694169516961697169816991700170117021703170417051706170717081709171017111712171317141715171617171718171917201721172217231724172517261727172817291730173117321733173417351736173717381739174017411742174317441745174617471748174917501751175217531754175517561757175817591760176117621763176417651766176717681769177017711772177317741775177617771778177917801781178217831784178517861787178817891790179117921793179417951796179717981799180018011802180318041805180618071808180918101811181218131814181518161817181818191820182118221823182418251826182718281829183018311832183318341835183618371838183918401841184218431844184518461847184818491850185118521853185418551856185718581859186018611862186318641865186618671868186918701871187218731874187518761877187818791880188118821883188418851886188718881889189018911892189318941895189618971898189919001901190219031904190519061907190819091910191119121913191419151916191719181919192019211922192319241925192619271928192919301931193219331934193519361937193819391940194119421943194419451946194719481949195019511952195319541955195619571958195919601961196219631964196519661967196819691970197119721973197419751976197719781979198019811982198319841985198619871988198919901991199219931994199519961997199819992000200120022003200420052006200720082009201020112012201320142015201620172018201920202021202220232024202520262027202820292030203120322033203420352036203720382039204020412042204320442045204620472048204920502051205220532054205520562057205820592060206120622063206420652066206720682069207020712072207320742075207620772078
/*
* Copyright (c) 2021-2023 Huawei Device Co., Ltd.
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
/**
* @file
* @kit CoreFileKit
*/
import { AsyncCallback } from './@ohos.base';
export default fileIO;
/**
* fileio
*
* @namespace fileIO
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
*/
declare namespace fileIO {
export { access };
export { accessSync };
export { chmod };
export { chmodSync };
export { chown };
export { chownSync };
export { close };
export { closeSync };
export { copyFile };
export { copyFileSync };
export { createStream };
export { createStreamSync };
export { createWatcher };
export { fchmod };
export { fchmodSync };
export { fchown };
export { fchownSync };
export { fdatasync };
export { fdatasyncSync };
export { fdopenStream };
export { fdopenStreamSync };
export { fstat };
export { fstatSync };
export { fsync };
export { fsyncSync };
export { ftruncate };
export { ftruncateSync };
export { hash };
export { lchown };
export { lchownSync };
export { lstat };
export { lstatSync };
export { mkdir };
export { mkdirSync };
export { mkdtemp };
export { mkdtempSync };
export { open };
export { openSync };
export { opendir };
export { opendirSync };
export { read };
export { readSync };
export { readText };
export { readTextSync };
export { rename };
export { renameSync };
export { rmdir };
export { rmdirSync };
export { stat };
export { statSync };
export { symlink };
export { symlinkSync };
export { truncate };
export { truncateSync };
export { unlink };
export { unlinkSync };
export { write };
export { writeSync };
export { Dir };
export { Dirent };
export { ReadOut };
export { Stat };
export { Stream };
export { Watcher };
}
/**
* access.
*
* @param { string } path - path.
* @param { number } [mode = 0] - mode.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.access
*/
declare function access(path: string, mode?: number): Promise<void>;
/**
* access.
*
* @param { string } path - path.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.access
*/
declare function access(path: string, callback: AsyncCallback<void>): void;
/**
* access.
*
* @param { string } path - path.
* @param { number } [mode = 0] - mode.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.access
*/
declare function access(path: string, mode: number, callback: AsyncCallback<void>): void;
/**
* accessSync.
*
* @param { string } path - path.
* @param { number } [mode = 0] - mode.
* @throws { TypedError | Error } access fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.accessSync
*/
declare function accessSync(path: string, mode?: number): void;
/**
* close.
*
* @param { number } fd - fd.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.close
*/
declare function close(fd: number): Promise<void>;
/**
* close.
*
* @param { number } fd - fd.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.close
*/
declare function close(fd: number, callback: AsyncCallback<void>): void;
/**
* closeSync.
*
* @param { number } fd - fd.
* @throws { TypedError | Error } close fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.closeSync
*/
declare function closeSync(fd: number): void;
/**
* copyFile.
*
* @param { string | number } src - src.
* @param { string | number } dest - dest.
* @param { number } [mode = 0] - mode.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.copyFile
*/
declare function copyFile(src: string | number, dest: string | number, mode?: number): Promise<void>;
/**
* copyFile.
*
* @param { string | number } src - src.
* @param { string | number } dest - dest.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.copyFile
*/
declare function copyFile(src: string | number, dest: string | number, callback: AsyncCallback<void>): void;
/**
* copyFile.
*
* @param { string | number } src - src.
* @param { string | number } dest - dest.
* @param { number } [mode = 0] - mode.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.copyFile
*/
declare function copyFile(
src: string | number,
dest: string | number,
mode: number,
callback: AsyncCallback<void>
): void;
/**
* copyFileSync.
*
* @param { string | number } src - src.
* @param { string | number } dest - dest.
* @param { number } [mode = 0] - mode.
* @throws { TypedError | Error } copyFile fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.copyFileSync
*/
declare function copyFileSync(src: string | number, dest: string | number, mode?: number): void;
/**
* createStream.
*
* @param { string } path - path.
* @param { string } mode - mode.
* @returns { Promise<Stream> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.createStream
*/
declare function createStream(path: string, mode: string): Promise<Stream>;
/**
* createStream.
*
* @param { string } path - path.
* @param { string } mode - mode.
* @param { AsyncCallback<Stream> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.createStream
*/
declare function createStream(path: string, mode: string, callback: AsyncCallback<Stream>): void;
/**
* createStreamSync.
*
* @param { string } path - path.
* @param { string } mode - mode.
* @returns { Stream } createStream success
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.createStreamSync
*/
declare function createStreamSync(path: string, mode: string): Stream;
/**
* chown.
*
* @param { string } path - path.
* @param { number } uid - mode.
* @param { number } gid - mode.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function chown(path: string, uid: number, gid: number): Promise<void>;
/**
* chown.
*
* @param { string } path - path.
* @param { number } uid - mode.
* @param { number } gid - mode.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function chown(path: string, uid: number, gid: number, callback: AsyncCallback<void>): void;
/**
* chownSync.
*
* @param { string } path - path.
* @param { number } uid - mode.
* @param { number } gid - mode.
* @throws { TypedError | Error } chown fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function chownSync(path: string, uid: number, gid: number): void;
/**
* chmod.
*
* @param { string } path - path.
* @param { number } mode - mode.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function chmod(path: string, mode: number): Promise<void>;
/**
* chmod.
*
* @param { string } path - path.
* @param { number } mode - mode.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function chmod(path: string, mode: number, callback: AsyncCallback<void>): void;
/**
* chmodSync.
*
* @param { string } path - path.
* @param { number } mode - mode.
* @throws { TypedError | Error } chmod fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function chmodSync(path: string, mode: number): void;
/**
* ftruncate.
*
* @param { number } fd - fd.
* @param { number } [len = 0] - len.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.truncate
*/
declare function ftruncate(fd: number, len?: number): Promise<void>;
/**
* ftruncate.
*
* @param { number } fd - fd.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.truncate
*/
declare function ftruncate(fd: number, callback: AsyncCallback<void>): void;
/**
* ftruncate.
*
* @param { number } fd - fd.
* @param { number } [len = 0] - len.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.truncate
*/
declare function ftruncate(fd: number, len: number, callback: AsyncCallback<void>): void;
/**
* ftruncateSync.
*
* @param { number } fd - fd.
* @param { number } [len = 0] - len.
* @throws { TypedError | Error } ftruncate fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.truncateSync
*/
declare function ftruncateSync(fd: number, len?: number): void;
/**
* fsync.
*
* @param { number } fd - fd.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fsync
*/
declare function fsync(fd: number): Promise<void>;
/**
* fsync.
*
* @param { number } fd - fd.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fsync
*/
declare function fsync(fd: number, callback: AsyncCallback<void>): void;
/**
* fsyncSync.
*
* @param { number } fd - fd.
* @throws { TypedError | Error } fsync fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fsyncSync
*/
declare function fsyncSync(fd: number): void;
/**
* fstat.
*
* @param { number } fd - fd.
* @returns { Promise<Stat> } return Promise
* @throws { TypedError } fstat fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.stat
*/
declare function fstat(fd: number): Promise<Stat>;
/**
* fstat.
*
* @param { number } fd - fd.
* @param { AsyncCallback<Stat> } callback
* @throws { TypedError } fstat fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.stat
*/
declare function fstat(fd: number, callback: AsyncCallback<Stat>): void;
/**
* fstatSync.
*
* @param { number } fd - fd.
* @returns { Stat } stat success
* @throws { TypedError | Error } fstat fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.statSync
*/
declare function fstatSync(fd: number): Stat;
/**
* fdatasync.
*
* @param { number } fd - fd.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fdatasync
*/
declare function fdatasync(fd: number): Promise<void>;
/**
* fdatasync.
*
* @param { number } fd - fd.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fdatasync
*/
declare function fdatasync(fd: number, callback: AsyncCallback<void>): void;
/**
* fdatasyncSync.
*
* @param { number } fd - fd.
* @throws { TypedError | Error } fdatasync fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fdatasyncSync
*/
declare function fdatasyncSync(fd: number): void;
/**
* fchown.
*
* @param { number } fd - fd.
* @param { number } uid - uid.
* @param { number } gid - gid.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function fchown(fd: number, uid: number, gid: number): Promise<void>;
/**
* fchown.
*
* @param { number } fd - fd.
* @param { number } uid - uid.
* @param { number } gid - gid.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function fchown(fd: number, uid: number, gid: number, callback: AsyncCallback<void>): void;
/**
* fchownSync.
*
* @param { number } fd - fd.
* @param { number } uid - uid.
* @param { number } gid - gid.
* @throws { TypedError | Error } fchown fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function fchownSync(fd: number, uid: number, gid: number): void;
/**
* fchmod.
*
* @param { number } fd - fd.
* @param { number } mode - mode.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function fchmod(fd: number, mode: number): Promise<void>;
/**
* fchmod.
*
* @param { number } fd - fd.
* @param { number } mode - mode.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function fchmod(fd: number, mode: number, callback: AsyncCallback<void>): void;
/**
* fchmodSync.
*
* @param { number } fd - fd.
* @param { number } mode - mode.
* @throws { TypedError | Error } fchmod fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function fchmodSync(fd: number, mode: number): void;
/**
* fdopenStream.
*
* @param { number } fd - fd.
* @param { string } mode - mode.
* @returns { Promise<Stream> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fdopenStream
*/
declare function fdopenStream(fd: number, mode: string): Promise<Stream>;
/**
* fdopenStream.
*
* @param { number } fd - fd.
* @param { string } mode - mode.
* @param { AsyncCallback<Stream> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fdopenStream
*/
declare function fdopenStream(fd: number, mode: string, callback: AsyncCallback<Stream>): void;
/**
* fdopenStreamSync.
*
* @param { number } fd - fd.
* @param { string } mode - mode.
* @returns { Stream } open stream from fd
* @throws { TypedError | Error } open fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.fdopenStreamSync
*/
declare function fdopenStreamSync(fd: number, mode: string): Stream;
/**
* hash.
*
* @param { string } path - path.
* @param { string } algorithm - algorithm md5 sha1 sha256.
* @returns { Promise<string> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.hash.hash
*/
declare function hash(path: string, algorithm: string): Promise<string>;
/**
* hash.
*
* @param { string } path - path.
* @param { string } algorithm - algorithm md5 sha1 sha256.
* @param { AsyncCallback<string> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.hash.hash
*/
declare function hash(path: string, algorithm: string, callback: AsyncCallback<string>): void;
/**
* lchown.
*
* @param { string } path - path.
* @param { number } uid - uid.
* @param { number } gid - gid.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function lchown(path: string, uid: number, gid: number): Promise<void>;
/**
* lchown.
*
* @param { string } path - path.
* @param { number } uid - uid.
* @param { number } gid - gid.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function lchown(path: string, uid: number, gid: number, callback: AsyncCallback<void>): void;
/**
* lchownSync.
*
* @param { string } path - path.
* @param { number } uid - uid.
* @param { number } gid - gid.
* @throws { TypedError | Error } lchown fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
*/
declare function lchownSync(path: string, uid: number, gid: number): void;
/**
* lstat.
*
* @param { string } path - path.
* @returns { Promise<Stat> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.lstat
*/
declare function lstat(path: string): Promise<Stat>;
/**
* lstat.
*
* @param { string } path - path.
* @param { AsyncCallback<Stat> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.lstat
*/
declare function lstat(path: string, callback: AsyncCallback<Stat>): void;
/**
* lstatSync.
*
* @param { string } path - path.
* @returns { Stat } lstat success
* @throws { TypedError | Error } lstat fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.lstatSync
*/
declare function lstatSync(path: string): Stat;
/**
* mkdir.
*
* @param { string } path - path.
* @param { number } [mode = 0o770] - path.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.mkdir
*/
declare function mkdir(path: string, mode?: number): Promise<void>;
/**
* mkdir.
*
* @param { string } path - path.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.mkdir
*/
declare function mkdir(path: string, callback: AsyncCallback<void>): void;
/**
* mkdir.
*
* @param { string } path - path.
* @param { number } [mode = 0o770] - path.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.mkdir
*/
declare function mkdir(path: string, mode: number, callback: AsyncCallback<void>): void;
/**
* mkdirSync.
*
* @param { string } path - path.
* @param { number } [mode = 0o770] - path.
* @throws { TypedError | Error } mkdir fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.mkdirSync
*/
declare function mkdirSync(path: string, mode?: number): void;
/**
* mkdtemp.
*
* @param { string } prefix - dir prefix.
* @returns { Promise<string> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.mkdtemp
*/
declare function mkdtemp(prefix: string): Promise<string>;
/**
* mkdtemp.
*
* @param { string } prefix - dir prefix.
* @param { AsyncCallback<string> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.mkdtemp
*/
declare function mkdtemp(prefix: string, callback: AsyncCallback<string>): void;
/**
* mkdtempSync.
*
* @param { string } prefix - dir prefix.
* @returns { string } directory name
* @throws { TypedError | Error } mkdtemp fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.mkdtempSync
*/
declare function mkdtempSync(prefix: string): string;
/**
* open.
*
* @param { string } path - path.
* @param { number } [flags = 0] - flags.
* @param { number } [mode = 0o666] - mode.
* @returns { Promise<number> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.open
*/
declare function open(path: string, flags?: number, mode?: number): Promise<number>;
/**
* open.
*
* @param { string } path - path.
* @param { AsyncCallback<number> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.open
*/
declare function open(path: string, callback: AsyncCallback<number>): void;
/**
* open.
*
* @param { string } path - path.
* @param { number } [flags = 0] - flags.
* @param { AsyncCallback<number> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.open
*/
declare function open(path: string, flags: number, callback: AsyncCallback<number>): void;
/**
* open.
*
* @param { string } path - path.
* @param { number } [flags = 0] - flags.
* @param { number } [mode = 0o666] - mode.
* @param { AsyncCallback<number> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.open
*/
declare function open(path: string, flags: number, mode: number, callback: AsyncCallback<number>): void;
/**
* openSync.
*
* @param { string } path - path.
* @param { number } [flags = 0] - flags.
* @param { number } [mode = 0o666] - mode.
* @returns { number } open fd
* @throws { TypedError | Error } open fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.openSync
*/
declare function openSync(path: string, flags?: number, mode?: number): number;
/**
* opendir.
*
* @param { string } path - directory name.
* @returns { Promise<Dir> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
declare function opendir(path: string): Promise<Dir>;
/**
* opendir.
*
* @param { string } path - directory name.
* @param { AsyncCallback<Dir> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
declare function opendir(path: string, callback: AsyncCallback<Dir>): void;
/**
* opendirSync.
*
* @param { string } path - directory name.
* @returns { Dir } opendir Dir Object
* @throws { TypedError | Error } opendir fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFileSync
*/
declare function opendirSync(path: string): Dir;
/**
* readText.
*
* @param { string } filePath - file path.
* @param { object } [options] - options.
* @returns { Promise<string> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.readText
*/
declare function readText(
filePath: string,
options?: {
position?: number;
length?: number;
encoding?: string;
}
): Promise<string>;
/**
* readText.
*
* @param { string } filePath - file path.
* @param { object } [options] - options.
* @param { AsyncCallback<string> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.readText
*/
declare function readText(
filePath: string,
options: {
position?: number;
length?: number;
encoding?: string;
},
callback: AsyncCallback<string>
): void;
/**
* readTextSync.
*
* @param { string } filePath - file path.
* @param { object } [options] - options.
* @returns { string } readout result
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.readTextSync
*/
declare function readTextSync(
filePath: string,
options?: {
position?: number;
length?: number;
encoding?: string;
}
): string;
/**
* read.
*
* @param { number } fd - file descriptor.
* @param { ArrayBuffer } buffer - file descriptor.
* @param { object } [options] - options.
* @returns { Promise<ReadOut> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.read
*/
declare function read(
fd: number,
buffer: ArrayBuffer,
options?: {
offset?: number;
length?: number;
position?: number;
}
): Promise<ReadOut>;
/**
* read.
*
* @param { number } fd - file descriptor.
* @param { ArrayBuffer } buffer - file descriptor.
* @param { AsyncCallback<ReadOut> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.read
*/
declare function read(fd: number, buffer: ArrayBuffer, callback: AsyncCallback<ReadOut>): void;
/**
* read.
*
* @param { number } fd - file descriptor.
* @param { ArrayBuffer } buffer - file descriptor.
* @param { object } [options] - options.
* @param { AsyncCallback<ReadOut> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.read
*/
declare function read(
fd: number,
buffer: ArrayBuffer,
options: {
offset?: number;
length?: number;
position?: number;
},
callback: AsyncCallback<ReadOut>
): void;
/**
* readSync.
*
* @param { number } fd - file descriptor.
* @param { ArrayBuffer } buffer - file descriptor.
* @param { object } [options] - options.
* @returns { number } number of bytesRead
* @throws { TypedError | Error } read fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.readSync
*/
declare function readSync(
fd: number,
buffer: ArrayBuffer,
options?: {
offset?: number;
length?: number;
position?: number;
}
): number;
/**
* rename.
*
* @param { string } oldPath - oldPath.
* @param { string } newPath - newPath.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.rename
*/
declare function rename(oldPath: string, newPath: string): Promise<void>;
/**
* rename.
*
* @param { string } oldPath - oldPath.
* @param { string } newPath - newPath.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.rename
*/
declare function rename(oldPath: string, newPath: string, callback: AsyncCallback<void>): void;
/**
* renameSync.
*
* @param { string } oldPath - oldPath.
* @param { string } newPath - newPath.
* @throws { TypedError | Error } rename fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.renameSync
*/
declare function renameSync(oldPath: string, newPath: string): void;
/**
* rmdir.
*
* @param { string } path - path.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.rmdir
*/
declare function rmdir(path: string): Promise<void>;
/**
* rmdir.
*
* @param { string } path - path.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.rmdir
*/
declare function rmdir(path: string, callback: AsyncCallback<void>): void;
/**
* rmdirSync.
*
* @param { string } path - path.
* @throws { TypedError | Error } rmdir fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.rmdirSync
*/
declare function rmdirSync(path: string): void;
/**
* stat.
*
* @param { string } path - path.
* @returns { Promise<Stat> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.stat
*/
declare function stat(path: string): Promise<Stat>;
/**
* stat.
*
* @param { string } path - path.
* @param { AsyncCallback<Stat> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.stat
*/
declare function stat(path: string, callback: AsyncCallback<Stat>): void;
/**
* statSync.
*
* @param { string } path - path.
* @returns { Stat } stat success
* @throws { TypedError | Error } stat fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.statSync
*/
declare function statSync(path: string): Stat;
/**
* symlink.
*
* @param { string } target - target.
* @param { string } srcPath - srcPath.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.symlink
*/
declare function symlink(target: string, srcPath: string): Promise<void>;
/**
* symlink.
*
* @param { string } target - target.
* @param { string } srcPath - srcPath.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.symlink
*/
declare function symlink(target: string, srcPath: string, callback: AsyncCallback<void>): void;
/**
* symlinkSync.
*
* @param { string } target - target.
* @param { string } srcPath - srcPath.
* @throws { TypedError | Error } symlink fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.symlinkSync
*/
declare function symlinkSync(target: string, srcPath: string): void;
/**
* truncate.
*
* @param { string } path - path.
* @param { number } [len = 0] - len.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.truncate
*/
declare function truncate(path: string, len?: number): Promise<void>;
/**
* truncate.
*
* @param { string } path - path.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.truncate
*/
declare function truncate(path: string, callback: AsyncCallback<void>): void;
/**
* truncate.
*
* @param { string } path - path.
* @param { number } [len = 0] - len.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.truncate
*/
declare function truncate(path: string, len: number, callback: AsyncCallback<void>): void;
/**
* truncateSync.
*
* @param { string } path - path.
* @param { number } [len = 0] - len.
* @throws { TypedError | Error } truncate fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.truncateSync
*/
declare function truncateSync(path: string, len?: number): void;
/**
* unlink.
*
* @param { string } path - path.
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.unlink
*/
declare function unlink(path: string): Promise<void>;
/**
* unlink.
*
* @param { string } path - path.
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.unlink
*/
declare function unlink(path: string, callback: AsyncCallback<void>): void;
/**
* unlinkSync.
*
* @param { string } path - path.
* @throws { TypedError | Error } unlink fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.unlinkSync
*/
declare function unlinkSync(path: string): void;
/**
* write.
*
* @param { number } fd - file descriptor.
* @param { ArrayBuffer | string } buffer - buffer or string.
* @param { object } [options] - options.
* @returns { Promise<number> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.write
*/
declare function write(
fd: number,
buffer: ArrayBuffer | string,
options?: {
offset?: number;
length?: number;
position?: number;
encoding?: string;
}
): Promise<number>;
/**
* write.
*
* @param { number } fd - file descriptor.
* @param { ArrayBuffer | string } buffer - buffer or string.
* @param { AsyncCallback<number> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.write
*/
declare function write(fd: number, buffer: ArrayBuffer | string, callback: AsyncCallback<number>): void;
/**
* write.
*
* @param { number } fd - file descriptor.
* @param { ArrayBuffer | string } buffer - buffer or string.
* @param { object } [options] - options.
* @param { AsyncCallback<number> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.write
*/
declare function write(
fd: number,
buffer: ArrayBuffer | string,
options: {
offset?: number;
length?: number;
position?: number;
encoding?: string;
},
callback: AsyncCallback<number>
): void;
/**
* writeSync.
*
* @param { number } fd - file descriptor.
* @param { ArrayBuffer | string } buffer - buffer or string.
* @param { object } [options] - options.
* @returns { number } on success number of bytesRead
* @throws { TypedError | Error } write fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.writeSync
*/
declare function writeSync(
fd: number,
buffer: ArrayBuffer | string,
options?: {
offset?: number;
length?: number;
position?: number;
encoding?: string;
}
): number;
/**
* createWatcher.
*
* @param { string } filename - filename.
* @param { number } events - events(depends on OS & filesystem) events = 1 rename events = 2 change.
* @param { AsyncCallback<number> } [callback] - callback.
* @returns { Watcher } watch success
* @throws { TypedError | Error } watch fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 10
* @useinstead ohos.file.fs.createWatcher
*/
declare function createWatcher(filename: string, events: number, callback: AsyncCallback<number>): Watcher;
/**
* Dir
*
* @interface Dir
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
declare interface Dir {
/**
* read.
*
* @returns { Promise<Dirent> } return Promise
* @throws { TypedError } Parameter check failed if read to end, Error.msg = "NoMore"
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
read(): Promise<Dirent>;
/**
* read.
*
* @param { AsyncCallback<Dirent> } [callback] - callback.
* @throws { TypedError } Parameter check failed if read to end, Error.msg = "NoMore"
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
read(callback: AsyncCallback<Dirent>): void;
/**
* readSync.
*
* @returns { Dirent } Dirent Object
* @throws { TypedError | Error } read fail if read to end, Error.msg = "NoMore"
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
readSync(): Dirent;
/**
* close.
*
* @returns { Promise<void> } return Promise
* @throws { TypedError } close fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
close(): Promise<void>;
/**
* close.
*
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } close fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
close(callback: AsyncCallback<void>): void;
/**
* closeSync.
*
* @throws { TypedError | Error } close fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
closeSync(): void;
}
/**
* Dirent
*
* @interface Dirent
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
declare interface Dirent {
/**
* @type { string }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
readonly name: string;
/**
* isBlockDevice.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
isBlockDevice(): boolean;
/**
* isCharacterDevice.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
isCharacterDevice(): boolean;
/**
* isDirectory.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
isDirectory(): boolean;
/**
* isFIFO.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
isFIFO(): boolean;
/**
* isFile.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
isFile(): boolean;
/**
* isSocket.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
isSocket(): boolean;
/**
* isSymbolicLink.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.listFile
*/
isSymbolicLink(): boolean;
}
/**
* Stat
*
* @interface Stat
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat
*/
declare interface Stat {
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
*/
readonly dev: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.ino
*/
readonly ino: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.mode
*/
readonly mode: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
*/
readonly nlink: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.uid
*/
readonly uid: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.gid
*/
readonly gid: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
*/
readonly rdev: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.size
*/
readonly size: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
*/
readonly blocks: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.atime
*/
readonly atime: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.mtime
*/
readonly mtime: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.ctime
*/
readonly ctime: number;
/**
* isBlockDevice.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.isBlockDevice
*/
isBlockDevice(): boolean;
/**
* isCharacterDevice.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.isCharacterDevice
*/
isCharacterDevice(): boolean;
/**
* isDirectory.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.isDirectory
*/
isDirectory(): boolean;
/**
* isFIFO.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.isFIFO
*/
isFIFO(): boolean;
/**
* isFile.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.isFile
*/
isFile(): boolean;
/**
* isSocket.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.isSocket
*/
isSocket(): boolean;
/**
* isSymbolicLink.
*
* @returns { boolean } is or not
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stat.isSymbolicLink
*/
isSymbolicLink(): boolean;
}
/**
* Stream
*
* @interface Stream
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stream
*/
declare interface Stream {
/**
* close.
*
* @returns { Promise<void> } return Promise
* @throws { TypedError } close fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.close
*/
close(): Promise<void>;
/**
* close.
*
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } close fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.close
*/
close(callback: AsyncCallback<void>): void;
/**
* closeSync.
*
* @throws { TypedError | Error } close fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.closeSync
*/
closeSync(): void;
/**
* flush.
*
* @returns { Promise<void> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.flush
*/
flush(): Promise<void>;
/**
* flush.
*
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.flush
*/
flush(callback: AsyncCallback<void>): void;
/**
* flushSync.
*
* @throws { TypedError | Error } flush fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.flushSync
*/
flushSync(): void;
/**
* write.
*
* @param { ArrayBuffer | string } buffer - buffer or string.
* @param { object } [options] - options.
* @returns { Promise<number> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.write
*/
write(
buffer: ArrayBuffer | string,
options?: {
offset?: number;
length?: number;
position?: number;
encoding?: string;
}
): Promise<number>;
/**
* write.
*
* @param { ArrayBuffer | string } buffer - buffer or string.
* @param { AsyncCallback<number> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.write
*/
write(buffer: ArrayBuffer | string, callback: AsyncCallback<number>): void;
/**
* write.
*
* @param { ArrayBuffer | string } buffer - buffer or string.
* @param { object } [options] - options.
* @param { AsyncCallback<number> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.write
*/
write(
buffer: ArrayBuffer | string,
options: {
offset?: number;
length?: number;
position?: number;
encoding?: string;
},
callback: AsyncCallback<number>
): void;
/**
* writeSync.
*
* @param { ArrayBuffer | string } buffer - buffer or string.
* @param { object } [options] - options.
* @returns { number } on success number of bytes written
* @throws { TypedError | Error } write fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.writeSync
*/
writeSync(
buffer: ArrayBuffer | string,
options?: {
offset?: number;
length?: number;
position?: number;
encoding?: string;
}
): number;
/**
* read.
*
* @param { ArrayBuffer } buffer - buffer.
* @param { object } [options] - options.
* @returns { Promise<ReadOut> } return Promise
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.read
*/
read(
buffer: ArrayBuffer,
options?: {
position?: number;
offset?: number;
length?: number;
}
): Promise<ReadOut>;
/**
* read.
*
* @param { ArrayBuffer } buffer - buffer.
* @param { AsyncCallback<ReadOut> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.read
*/
read(buffer: ArrayBuffer, callback: AsyncCallback<ReadOut>): void;
/**
* read.
*
* @param { ArrayBuffer } buffer - buffer.
* @param { object } [options] - options.
* @param { AsyncCallback<ReadOut> } [callback] - callback.
* @throws { TypedError } Parameter check failed
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.read
*/
read(
buffer: ArrayBuffer,
options: {
position?: number;
offset?: number;
length?: number;
},
callback: AsyncCallback<ReadOut>
): void;
/**
* readSync.
*
* @param { ArrayBuffer } buffer - buffer.
* @param { object } [options] - options.
* @returns { number } number of bytesRead
* @throws { TypedError | Error } read fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 9
* @useinstead ohos.file.fs.Stream.readSync
*/
readSync(
buffer: ArrayBuffer,
options?: {
position?: number;
offset?: number;
length?: number;
}
): number;
}
/**
* ReadOut
*
* @interface ReadOut
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
*/
declare interface ReadOut {
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
*/
bytesRead: number;
/**
* @type { number }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
*/
offset: number;
/**
* @type { ArrayBuffer }
* @readonly
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 6
* @deprecated since 9
*/
buffer: ArrayBuffer;
}
/**
* Watcher
*
* @interface Watcher
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 10
* @useinstead ohos.file.fs.Watcher
*/
declare interface Watcher {
/**
* stop.
*
* @returns { Promise<void> } return Promise
* @throws { TypedError | Error } stop fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 10
* @useinstead ohos.file.fs.Watcher.stop
*/
stop(): Promise<void>;
/**
* stop.
*
* @param { AsyncCallback<void> } [callback] - callback.
* @throws { TypedError | Error } stop fail
* @syscap SystemCapability.FileManagement.File.FileIO
* @since 7
* @deprecated since 10
* @useinstead ohos.file.fs.Watcher.stop
*/
stop(callback: AsyncCallback<void>): void;
}
1
https://gitee.com/openharmony/interface_sdk-js.git
git@gitee.com:openharmony/interface_sdk-js.git
openharmony
interface_sdk-js
interface_sdk-js
master

搜索帮助