1 Star 0 Fork 4K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.fileio.d.ts 54.09 KB
一键复制 编辑 原始数据 按行查看 历史
zhuhongtao666 提交于 2024-07-05 19:11 +08:00 . remove kit
1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077
/*
* 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
*/
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;
}
Loading...
马建仓 AI 助手
尝试更多
代码解读
代码找茬
代码优化
1
https://gitee.com/lffl8796/interface_sdk-js.git
git@gitee.com:lffl8796/interface_sdk-js.git
lffl8796
interface_sdk-js
interface_sdk-js
master

搜索帮助