1 Star 0 Fork 4K

Feng Lin/interface_sdk-js

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
文件
克隆/下载
@ohos.util.d.ts 182.11 KB
一键复制 编辑 原始数据 按行查看 历史
wang-jingwu001 提交于 2024-08-30 11:22 +08:00 . Modify some errors in util.d.ts
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786787788789790791792793794795796797798799800801802803804805806807808809810811812813814815816817818819820821822823824825826827828829830831832833834835836837838839840841842843844845846847848849850851852853854855856857858859860861862863864865866867868869870871872873874875876877878879880881882883884885886887888889890891892893894895896897898899900901902903904905906907908909910911912913914915916917918919920921922923924925926927928929930931932933934935936937938939940941942943944945946947948949950951952953954955956957958959960961962963964965966967968969970971972973974975976977978979980981982983984985986987988989990991992993994995996997998999100010011002100310041005100610071008100910101011101210131014101510161017101810191020102110221023102410251026102710281029103010311032103310341035103610371038103910401041104210431044104510461047104810491050105110521053105410551056105710581059106010611062106310641065106610671068106910701071107210731074107510761077107810791080108110821083108410851086108710881089109010911092109310941095109610971098109911001101110211031104110511061107110811091110111111121113111411151116111711181119112011211122112311241125112611271128112911301131113211331134113511361137113811391140114111421143114411451146114711481149115011511152115311541155115611571158115911601161116211631164116511661167116811691170117111721173117411751176117711781179118011811182118311841185118611871188118911901191119211931194119511961197119811991200120112021203120412051206120712081209121012111212121312141215121612171218121912201221122212231224122512261227122812291230123112321233123412351236123712381239124012411242124312441245124612471248124912501251125212531254125512561257125812591260126112621263126412651266126712681269127012711272127312741275127612771278127912801281128212831284128512861287128812891290129112921293129412951296129712981299130013011302130313041305130613071308130913101311131213131314131513161317131813191320132113221323132413251326132713281329133013311332133313341335133613371338133913401341134213431344134513461347134813491350135113521353135413551356135713581359136013611362136313641365136613671368136913701371137213731374137513761377137813791380138113821383138413851386138713881389139013911392139313941395139613971398139914001401140214031404140514061407140814091410141114121413141414151416141714181419142014211422142314241425142614271428142914301431143214331434143514361437143814391440144114421443144414451446144714481449145014511452145314541455145614571458145914601461146214631464146514661467146814691470147114721473147414751476147714781479148014811482148314841485148614871488148914901491149214931494149514961497149814991500150115021503150415051506150715081509151015111512151315141515151615171518151915201521152215231524152515261527152815291530153115321533153415351536153715381539154015411542154315441545154615471548154915501551155215531554155515561557155815591560156115621563156415651566156715681569157015711572157315741575157615771578157915801581158215831584158515861587158815891590159115921593159415951596159715981599160016011602160316041605160616071608160916101611161216131614161516161617161816191620162116221623162416251626162716281629163016311632163316341635163616371638163916401641164216431644164516461647164816491650165116521653165416551656165716581659166016611662166316641665166616671668166916701671167216731674167516761677167816791680168116821683168416851686168716881689169016911692169316941695169616971698169917001701170217031704170517061707170817091710171117121713171417151716171717181719172017211722172317241725172617271728172917301731173217331734173517361737173817391740174117421743174417451746174717481749175017511752175317541755175617571758175917601761176217631764176517661767176817691770177117721773177417751776177717781779178017811782178317841785178617871788178917901791179217931794179517961797179817991800180118021803180418051806180718081809181018111812181318141815181618171818181918201821182218231824182518261827182818291830183118321833183418351836183718381839184018411842184318441845184618471848184918501851185218531854185518561857185818591860186118621863186418651866186718681869187018711872187318741875187618771878187918801881188218831884188518861887188818891890189118921893189418951896189718981899190019011902190319041905190619071908190919101911191219131914191519161917191819191920192119221923192419251926192719281929193019311932193319341935193619371938193919401941194219431944194519461947194819491950195119521953195419551956195719581959196019611962196319641965196619671968196919701971197219731974197519761977197819791980198119821983198419851986198719881989199019911992199319941995199619971998199920002001200220032004200520062007200820092010201120122013201420152016201720182019202020212022202320242025202620272028202920302031203220332034203520362037203820392040204120422043204420452046204720482049205020512052205320542055205620572058205920602061206220632064206520662067206820692070207120722073207420752076207720782079208020812082208320842085208620872088208920902091209220932094209520962097209820992100210121022103210421052106210721082109211021112112211321142115211621172118211921202121212221232124212521262127212821292130213121322133213421352136213721382139214021412142214321442145214621472148214921502151215221532154215521562157215821592160216121622163216421652166216721682169217021712172217321742175217621772178217921802181218221832184218521862187218821892190219121922193219421952196219721982199220022012202220322042205220622072208220922102211221222132214221522162217221822192220222122222223222422252226222722282229223022312232223322342235223622372238223922402241224222432244224522462247224822492250225122522253225422552256225722582259226022612262226322642265226622672268226922702271227222732274227522762277227822792280228122822283228422852286228722882289229022912292229322942295229622972298229923002301230223032304230523062307230823092310231123122313231423152316231723182319232023212322232323242325232623272328232923302331233223332334233523362337233823392340234123422343234423452346234723482349235023512352235323542355235623572358235923602361236223632364236523662367236823692370237123722373237423752376237723782379238023812382238323842385238623872388238923902391239223932394239523962397239823992400240124022403240424052406240724082409241024112412241324142415241624172418241924202421242224232424242524262427242824292430243124322433243424352436243724382439244024412442244324442445244624472448244924502451245224532454245524562457245824592460246124622463246424652466246724682469247024712472247324742475247624772478247924802481248224832484248524862487248824892490249124922493249424952496249724982499250025012502250325042505250625072508250925102511251225132514251525162517251825192520252125222523252425252526252725282529253025312532253325342535253625372538253925402541254225432544254525462547254825492550255125522553255425552556255725582559256025612562256325642565256625672568256925702571257225732574257525762577257825792580258125822583258425852586258725882589259025912592259325942595259625972598259926002601260226032604260526062607260826092610261126122613261426152616261726182619262026212622262326242625262626272628262926302631263226332634263526362637263826392640264126422643264426452646264726482649265026512652265326542655265626572658265926602661266226632664266526662667266826692670267126722673267426752676267726782679268026812682268326842685268626872688268926902691269226932694269526962697269826992700270127022703270427052706270727082709271027112712271327142715271627172718271927202721272227232724272527262727272827292730273127322733273427352736273727382739274027412742274327442745274627472748274927502751275227532754275527562757275827592760276127622763276427652766276727682769277027712772277327742775277627772778277927802781278227832784278527862787278827892790279127922793279427952796279727982799280028012802280328042805280628072808280928102811281228132814281528162817281828192820282128222823282428252826282728282829283028312832283328342835283628372838283928402841284228432844284528462847284828492850285128522853285428552856285728582859286028612862286328642865286628672868286928702871287228732874287528762877287828792880288128822883288428852886288728882889289028912892289328942895289628972898289929002901290229032904290529062907290829092910291129122913291429152916291729182919292029212922292329242925292629272928292929302931293229332934293529362937293829392940294129422943294429452946294729482949295029512952295329542955295629572958295929602961296229632964296529662967296829692970297129722973297429752976297729782979298029812982298329842985298629872988298929902991299229932994299529962997299829993000300130023003300430053006300730083009301030113012301330143015301630173018301930203021302230233024302530263027302830293030303130323033303430353036303730383039304030413042304330443045304630473048304930503051305230533054305530563057305830593060306130623063306430653066306730683069307030713072307330743075307630773078307930803081308230833084308530863087308830893090309130923093309430953096309730983099310031013102310331043105310631073108310931103111311231133114311531163117311831193120312131223123312431253126312731283129313031313132313331343135313631373138313931403141314231433144314531463147314831493150315131523153315431553156315731583159316031613162316331643165316631673168316931703171317231733174317531763177317831793180318131823183318431853186318731883189319031913192319331943195319631973198319932003201320232033204320532063207320832093210321132123213321432153216321732183219322032213222322332243225322632273228322932303231323232333234323532363237323832393240324132423243324432453246324732483249325032513252325332543255325632573258325932603261326232633264326532663267326832693270327132723273327432753276327732783279328032813282328332843285328632873288328932903291329232933294329532963297329832993300330133023303330433053306330733083309331033113312331333143315331633173318331933203321332233233324332533263327332833293330333133323333333433353336333733383339334033413342334333443345334633473348334933503351335233533354335533563357335833593360336133623363336433653366336733683369337033713372337333743375337633773378337933803381338233833384338533863387338833893390339133923393339433953396339733983399340034013402340334043405340634073408340934103411341234133414341534163417341834193420342134223423342434253426342734283429343034313432343334343435343634373438343934403441344234433444344534463447344834493450345134523453345434553456345734583459346034613462346334643465346634673468346934703471347234733474347534763477347834793480348134823483348434853486348734883489349034913492349334943495349634973498349935003501350235033504350535063507350835093510351135123513351435153516351735183519352035213522352335243525352635273528352935303531353235333534353535363537353835393540354135423543354435453546354735483549355035513552355335543555355635573558355935603561356235633564356535663567356835693570357135723573357435753576357735783579358035813582358335843585358635873588358935903591359235933594359535963597359835993600360136023603360436053606360736083609361036113612361336143615361636173618361936203621362236233624362536263627362836293630363136323633363436353636363736383639364036413642364336443645364636473648364936503651365236533654365536563657365836593660366136623663366436653666366736683669367036713672367336743675367636773678367936803681368236833684368536863687368836893690369136923693369436953696369736983699370037013702370337043705370637073708370937103711371237133714371537163717371837193720372137223723372437253726372737283729373037313732373337343735373637373738373937403741374237433744374537463747374837493750375137523753375437553756375737583759376037613762376337643765376637673768376937703771377237733774377537763777377837793780378137823783378437853786378737883789379037913792379337943795379637973798379938003801380238033804380538063807380838093810381138123813381438153816381738183819382038213822382338243825382638273828382938303831383238333834383538363837383838393840384138423843384438453846384738483849385038513852385338543855385638573858385938603861386238633864386538663867386838693870387138723873387438753876387738783879388038813882388338843885388638873888388938903891389238933894389538963897389838993900390139023903390439053906390739083909391039113912391339143915391639173918391939203921392239233924392539263927392839293930393139323933393439353936393739383939394039413942394339443945394639473948394939503951395239533954395539563957395839593960396139623963396439653966396739683969397039713972397339743975397639773978397939803981398239833984398539863987398839893990399139923993399439953996399739983999400040014002400340044005400640074008400940104011401240134014401540164017401840194020402140224023402440254026402740284029403040314032403340344035403640374038403940404041404240434044404540464047404840494050405140524053405440554056405740584059406040614062406340644065406640674068406940704071407240734074407540764077407840794080408140824083408440854086408740884089409040914092409340944095409640974098409941004101410241034104410541064107410841094110411141124113411441154116411741184119412041214122412341244125412641274128412941304131413241334134413541364137413841394140414141424143414441454146414741484149415041514152415341544155415641574158415941604161416241634164416541664167416841694170417141724173417441754176417741784179418041814182418341844185418641874188418941904191419241934194419541964197419841994200420142024203420442054206420742084209421042114212421342144215421642174218421942204221422242234224422542264227422842294230423142324233423442354236423742384239424042414242424342444245424642474248424942504251425242534254425542564257425842594260426142624263426442654266426742684269427042714272427342744275427642774278427942804281428242834284428542864287428842894290429142924293429442954296429742984299430043014302430343044305430643074308430943104311431243134314431543164317431843194320432143224323432443254326432743284329433043314332433343344335433643374338433943404341434243434344434543464347434843494350435143524353435443554356435743584359436043614362436343644365436643674368436943704371437243734374437543764377437843794380438143824383438443854386438743884389439043914392439343944395439643974398439944004401440244034404440544064407440844094410441144124413441444154416441744184419442044214422442344244425442644274428442944304431443244334434443544364437443844394440444144424443444444454446444744484449445044514452445344544455445644574458445944604461446244634464446544664467446844694470447144724473447444754476447744784479448044814482448344844485448644874488448944904491449244934494449544964497449844994500450145024503450445054506450745084509451045114512451345144515451645174518451945204521452245234524452545264527452845294530453145324533453445354536453745384539454045414542454345444545454645474548454945504551455245534554455545564557455845594560456145624563456445654566456745684569457045714572457345744575457645774578457945804581458245834584458545864587458845894590459145924593459445954596459745984599460046014602460346044605460646074608460946104611461246134614461546164617461846194620462146224623462446254626462746284629463046314632463346344635463646374638463946404641464246434644464546464647464846494650465146524653465446554656465746584659466046614662466346644665466646674668466946704671467246734674467546764677467846794680468146824683468446854686468746884689469046914692469346944695469646974698469947004701470247034704470547064707470847094710471147124713471447154716471747184719472047214722472347244725472647274728472947304731473247334734473547364737473847394740474147424743474447454746474747484749475047514752475347544755475647574758475947604761476247634764476547664767476847694770477147724773477447754776477747784779478047814782478347844785478647874788478947904791479247934794479547964797479847994800480148024803480448054806480748084809481048114812481348144815481648174818481948204821482248234824482548264827482848294830483148324833483448354836483748384839484048414842484348444845484648474848484948504851485248534854485548564857485848594860486148624863486448654866486748684869487048714872487348744875487648774878487948804881488248834884488548864887488848894890489148924893489448954896489748984899
/*
* Copyright (c) 2021-2022 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 ArkTS
*/
/**
* TextDecoder support full encoding in ICU data utf-8 utf-16 iso8859 must support in all device, TextEncoder takes a
* stream of code points as input and emits a stream of UTF-8 bytes, and system help function.
*
* @namespace util
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* TextDecoder support full encoding in ICU data utf-8 utf-16 iso8859 must support in all device, TextEncoder takes a
* stream of code points as input and emits a stream of UTF-8 bytes, and system help function.
*
* @namespace util
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* TextDecoder support full encoding in ICU data utf-8 utf-16 iso8859 must support in all device, TextEncoder takes a
* stream of code points as input and emits a stream of UTF-8 bytes, and system help function.
*
* @namespace util
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
declare namespace util {
/**
* %s: String will be used to convert all values except BigInt, Object and -0. BigInt values will be represented
* with an n and Objects that have no user defined toString function are inspected using util.inspect() with
* options { depth: 0, colors: false, compact: 3 }.
* %d: Number will be used to convert all values except BigInt and Symbol.
* %i: parseInt(value, 10) is used for all values except BigInt and Symbol.
* %f: parseFloat(value) is used for all values except Bigint and Symbol.
* %j: JSON. Replaced with the string '[Circular]' if the argument contains circular references.
* %o: Object. A string representation of an object with generic JavaScript object formatting.Similar to
* util.inspect() with options { showHidden: true, showProxy: true}. This will show the full object including
* non-enumerable properties and proxies.
* %O: Object. A string representation of an object with generic JavaScript object formatting.
* %O: Object. A string representation of an object with generic JavaScript object formatting.Similar to
* util.inspect() without options. This will show the full object not including non-enumerable properties and
* proxies.
* %c: CSS. This specifier is ignored and will skip any CSS passed in.
* %%: single percent sign ('%'). This does not consume an argument.Returns: <string> The formatted string.
*
* @param { string } format - Styled string
* @param { Object[] } args - Data to be formatted
* @returns { string } Return the character string formatted in a specific format
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.util.format
*/
function printf(format: string, ...args: Object[]): string;
/**
* %s: String will be used to convert all values except BigInt, Object and -0. BigInt values will be represented
* with an n and Objects that have no user defined toString function are inspected using util.inspect() with
* options { depth: 0, colors: false, compact: 3 }.
* %d: Number will be used to convert all values except BigInt and Symbol.
* %i: parseInt(value, 10) is used for all values except BigInt and Symbol.
* %f: parseFloat(value) is used for all values except Bigint and Symbol.
* %j: JSON. Replaced with the string '[Circular]' if the argument contains circular references.
* %o: Object. A string representation of an object with generic JavaScript object formatting.Similar to
* util.inspect() with options { showHidden: true, showProxy: true}. This will show the full object including
* non-enumerable properties and proxies.
* %O: Object. A string representation of an object with generic JavaScript object formatting.
* %O: Object. A string representation of an object with generic JavaScript object formatting.Similar to
* util.inspect() without options. This will show the full object not including non-enumerable properties and
* proxies.
* %c: CSS. This specifier is ignored and will skip any CSS passed in.
* %%: single percent sign ('%'). This does not consume an argument.Returns: <string> The formatted string.
*
* @param { string } format - Styled string
* @param { Object[] } args - Data to be formatted
* @returns { string } Return the character string formatted in a specific format
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* %s: String will be used to convert all values except BigInt, Object and -0. BigInt values will be represented
* with an n and Objects that have no user defined toString function are inspected using util.inspect() with
* options { depth: 0, colors: false, compact: 3 }.
* %d: Number will be used to convert all values except BigInt and Symbol.
* %i: parseInt(value, 10) is used for all values except BigInt and Symbol.
* %f: parseFloat(value) is used for all values except Bigint and Symbol.
* %j: JSON. Replaced with the string '[Circular]' if the argument contains circular references.
* %o: Object. A string representation of an object with generic JavaScript object formatting.Similar to
* util.inspect() with options { showHidden: true, showProxy: true}. This will show the full object including
* non-enumerable properties and proxies.
* %O: Object. A string representation of an object with generic JavaScript object formatting.
* %O: Object. A string representation of an object with generic JavaScript object formatting.Similar to
* util.inspect() without options. This will show the full object not including non-enumerable properties and
* proxies.
* %c: CSS. This specifier is ignored and will skip any CSS passed in.
* %%: single percent sign ('%'). This does not consume an argument.Returns: <string> The formatted string.
*
* @param { string } format - Styled string
* @param { Object[] } args - Data to be formatted
* @returns { string } a string formatted in a specific format.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* %s: String will be used to convert all values except BigInt, Object and -0. BigInt values will be represented
* with an n and Objects that have no user defined toString function are inspected using util.inspect() with
* options { depth: 0, colors: false, compact: 3 }.
* %d: Number will be used to convert all values except BigInt and Symbol.
* %i: parseInt(value, 10) is used for all values except BigInt and Symbol.
* %f: parseFloat(value) is used for all values except Bigint and Symbol.
* %j: JSON. Replaced with the string '[Circular]' if the argument contains circular references.
* %o: Object. A string representation of an object with generic JavaScript object formatting.Similar to
* util.inspect() with options { showHidden: true, showProxy: true}. This will show the full object including
* non-enumerable properties and proxies.
* %O: Object. A string representation of an object with generic JavaScript object formatting.
* %O: Object. A string representation of an object with generic JavaScript object formatting.Similar to
* util.inspect() without options. This will show the full object not including non-enumerable properties and
* proxies.
* %c: CSS. This specifier is ignored and will skip any CSS passed in.
* %%: single percent sign ('%'). This does not consume an argument.Returns: <string> The formatted string.
*
* @param { string } format - Styled string
* @param { Object[] } args - Data to be formatted
* @returns { string } a string formatted in a specific format.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function format(format: string, ...args: Object[]): string;
/**
* Get the string name of the system errno.
*
* @param { number } errno - The error code generated by an error in the system
* @returns { string } Return the string name of a system errno
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.util.errnoToString
*/
function getErrorString(errno: number): string;
/**
* Get the string name of the system errno.
*
* @param { number } errno - The error code generated by an error in the system
* @returns { string } Return the string name of a system errno
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Get the string name of the system errno.
*
* @param { number } errno - The error code generated by an error in the system
* @returns { string } Return the string name of a system errno
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Get the string name of the system errno.
*
* @param { number } errno - The error code generated by an error in the system
* @returns { string } Return the string name of a system errno
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function errnoToString(errno: number): string;
/**
* Takes an async function (or a function that returns a Promise) and returns a function following the
* error-first callback style.
*
* @param { Function } original - Asynchronous function
* @returns { function } Return a Asynchronous function
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Takes an async function (or a function that returns a Promise) and returns a function following the
* error-first callback style.
*
* @param { Function } original - Asynchronous function
* @returns { function } Return a Asynchronous function
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Takes an async function (or a function that returns a Promise) and returns a function following the
* error-first callback style.
*
* @param { Function } original - Asynchronous function
* @returns { function } Return a Asynchronous function
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function callbackWrapper(original: Function): (err: Object, value: Object) => void;
/**
* Takes a function following the common error-first callback style, i.e taking an (err, value) =>
* callback as the last argument, and return a function that returns promises.
*
* @param { function } original - Asynchronous function
* @returns { function } Return a function that returns promises
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Takes a function following the common error-first callback style, i.e taking an (err, value) =>
* callback as the last argument, and return a function that returns promises.
*
* @param { function } original - Asynchronous function
* @returns { Function } Return a function that returns promises
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Takes a function following the common error-first callback style, i.e taking an (err, value) =>
* callback as the last argument, and return a function that returns promises.
*
* @param { function } original - Asynchronous function
* @returns { Function } Return a function that returns promises
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function promisify(original: (err: Object, value: Object) => void): Function;
/**
* Takes a function following the common error-first callback style, i.e taking an (err, value) =>
* callback as the last argument, and return a version that returns promises.
*
* @param { function } original - Asynchronous function
* @returns { Object } Return a version that returns promises
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.util.promisify
*/
function promiseWrapper(original: (err: Object, value: Object) => void): Object;
/**
* Generate a random RFC 4122 version 4 UUID using a cryptographically secure random number generator.
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { string } Return a string representing this UUID.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Generate a random RFC 4122 version 4 UUID using a cryptographically secure random number generator.
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { string } Return a string representing this UUID.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Generate a random RFC 4122 version 4 UUID using a cryptographically secure random number generator.
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { string } Return a string representing this UUID.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function generateRandomUUID(entropyCache?: boolean): string;
/**
* Generate a random RFC 4122 version 4 binary UUID using a cryptographically secure random number generator.
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { Uint8Array } Return a Uint8Array representing this UUID.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Generate a random RFC 4122 version 4 binary UUID using a cryptographically secure random number generator.
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { Uint8Array } Return a Uint8Array representing this UUID.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Generate a random RFC 4122 version 4 binary UUID using a cryptographically secure random number generator.
*
* @param { boolean } [entropyCache] - Whether to generate the UUID with using the cache. Default: true.
* @returns { Uint8Array } Return a Uint8Array representing this UUID.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function generateRandomBinaryUUID(entropyCache?: boolean): Uint8Array;
/**
* Parse a UUID from the string standard representation as described in the RFC 4122 version 4.
*
* @param { string } uuid - String that specifies a UUID
* @returns { Uint8Array } Return a Uint8Array representing this UUID. Throw SyntaxError if parsing fails.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Parse a UUID from the string standard representation as described in the RFC 4122 version 4.
*
* @param { string } uuid - String that specifies a UUID
* @returns { Uint8Array } Return a Uint8Array representing this UUID. Throw SyntaxError if parsing fails.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Parse a UUID from the string standard representation as described in the RFC 4122 version 4.
*
* @param { string } uuid - String that specifies a UUID
* @returns { Uint8Array } Return a Uint8Array representing this UUID. Throw SyntaxError if parsing fails.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @throws { BusinessError } 10200002 - Invalid uuid string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function parseUUID(uuid: string): Uint8Array;
/**
* Get the hash code of an object.
*
* @param { object } [object] - The object that need to get hash code.
* @returns { number } Return a hash code of an object.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
function getHash(object: object): number;
/**
* Defines the TextDecoder related options parameters.
*
* @interface TextDecoderOptions
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
interface TextDecoderOptions {
/**
* Is a fatal error displayed? The default value is false.
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
fatal?: boolean;
/**
* Do you want to ignore BOM tags? The default value is false.
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
ignoreBOM?: boolean;
}
/**
* Defines the decode with stream related options parameters.
*
* @interface DecodeWithStreamOptions
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
interface DecodeWithStreamOptions {
/**
* Does the call follow additional data blocks. The default value is false.
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
stream?: boolean;
}
/**
* Defines the decode with stream related options parameters.
*
* @interface DecodeToStringOptions
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
interface DecodeToStringOptions {
/**
* Stream option controls stream processing in decoding. The default value is false.
* @type { ?boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
stream?: boolean;
}
/**
* The TextDecoder represents a text decoder that accepts a string as input,
* decodes it in UTF-8 format, and outputs UTF-8 byte stream.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* The TextDecoder represents a text decoder that accepts a string as input,
* decodes it in UTF-8 format, and outputs UTF-8 byte stream.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The TextDecoder represents a text decoder that accepts a string as input,
* decodes it in UTF-8 format, and outputs UTF-8 byte stream.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class TextDecoder {
/**
* The textDecoder constructor.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The textDecoder constructor.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The textDecoder constructor.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
constructor();
/**
* The source encoding's name, lowercased.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* The source encoding's name, lowercased.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The source encoding's name, lowercased.
*
* @type { string }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
readonly encoding: string;
/**
* Returns `true` if error mode is "fatal", and `false` otherwise.
*
* @type { boolean }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Returns `true` if error mode is "fatal", and `false` otherwise.
*
* @type { boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns `true` if error mode is "fatal", and `false` otherwise.
*
* @type { boolean }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
readonly fatal: boolean;
/**
* Returns `true` if ignore BOM flag is set, and `false` otherwise.
*
* @type { false }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Returns `true` if ignore BOM flag is set, and `false` otherwise.
*
* @type { false }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns `true` if ignore BOM flag is set, and `false` otherwise.
*
* @type { false }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
readonly ignoreBOM = false;
/**
* The textDecoder constructor.
*
* @param { string } encoding - Decoding format
* @param { object } options - Options
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.util.TextDecoder.create
*/
constructor(encoding?: string, options?: { fatal?: boolean; ignoreBOM?: boolean });
/**
* Replaces the original constructor to process arguments and return a textDecoder object.
*
* @param { string } encoding - Decoding format
* @param { object } options - Options
* @returns { TextDecoder }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Replaces the original constructor to process arguments and return a textDecoder object.
*
* @param { string } encoding - Decoding format
* @param { object } options - Options
* @returns { TextDecoder }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Replaces the original constructor to process arguments and return a textDecoder object.
*
* @param { string } [encoding] - Decoding format
* @param { TextDecoderOptions } [options] - Options
* @returns { TextDecoder }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
static create(encoding?: string, options?: TextDecoderOptions): TextDecoder;
/**
* Returns the result of running encoding's decoder.
*
* @param { Uint8Array } input - Decoded numbers in accordance with the format
* @param { object } options - Options
* @returns { string } Return decoded text
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.util.decodeWithStream
*/
decode(input: Uint8Array, options?: { stream?: false }): string;
/**
* Decodes the input and returns a string. If options.stream is true, any incomplete byte sequences occurring
* at the end of the input are buffered internally and emitted after the next call to textDecoder.decode().
* If textDecoder.fatal is true, decoding errors that occur will result in a TypeError being thrown.
*
* @param { Uint8Array } input - Decoded numbers in accordance with the format
* @param { object } options - Options
* @returns { string } Return decoded text
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Decodes the input and returns a string. If options.stream is true, any incomplete byte sequences occurring
* at the end of the input are buffered internally and emitted after the next call to textDecoder.decode().
* If textDecoder.fatal is true, decoding errors that occur will result in a TypeError being thrown.
*
* @param { Uint8Array } input - Decoded numbers in accordance with the format
* @param { object } options - Options
* @returns { string } Return decoded text
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Decodes the input and returns a string. If options.stream is true, any incomplete byte sequences occurring
* at the end of the input are buffered internally and emitted after the next call to textDecoder.decode().
* If textDecoder.fatal is true, decoding errors that occur will result in a TypeError being thrown.
*
* @param { Uint8Array } input - Decoded numbers in accordance with the format
* @param { DecodeWithStreamOptions } [options] - Options
* @returns { string } Return decoded text
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
* @deprecated since 12
* @useinstead ohos.util.decodeToString
*/
decodeWithStream(input: Uint8Array, options?: DecodeWithStreamOptions): string;
/**
* The input is decoded and a string is returned.
* If options.stream is set to true, any incomplete byte sequences found at the end of the input are internally
* buffered and will be emitted after the next call to textDecoder.decodeToString().
* If textDecoder.fatal is set to true, any decoding errors that occur will result in a TypeError being thrown.
*
* @param { Uint8Array } input - Decoded numbers in accordance with the format.
* @param { DecodeToStringOptions } [options] - The default option is set to false.
* @returns { string } Return decoded text
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
decodeToString(input: Uint8Array, options?: DecodeToStringOptions): string;
}
/**
* Return encoded text.
*
* @interface EncodeIntoUint8ArrayInfo
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
interface EncodeIntoUint8ArrayInfo {
/**
* The read represents the number of characters that have been encoded.
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
read: number;
/**
* The written represents the number of bytes occupied by the encoded characters.
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
written: number;
}
/**
* The TextEncoder interface represents a text encoder.
* The encoder takes the byte stream as the input and outputs the String string.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* The TextEncoder interface represents a text encoder.
* The encoder takes the byte stream as the input and outputs the String string.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The TextEncoder interface represents a text encoder.
* The encoder takes the byte stream as the input and outputs the String string.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class TextEncoder {
/**
* Encoding format.
*
* @type { 'utf-8' }
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* Encoding format.
*
* @type { 'utf-8' }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Encoding format.
*
* @type { 'utf-8' }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
readonly encoding = 'utf-8';
/**
* The textEncoder constructor.
*
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* The textEncoder constructor.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The textEncoder constructor.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor();
/**
* The textEncoder constructor.
*
* @param { string } [encoding] - The string for encoding format.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The textEncoder constructor.
*
* @param { string } [encoding] - The string for encoding format.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The textEncoder constructor.
*
* @param { string } [encoding] - The string for encoding format.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor(encoding?: string);
/**
* Create a TextEncoder object.
*
* @param { string } [encoding] - The string for encoding format.
* @returns { TextEncoder }
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static create(encoding?: string): TextEncoder;
/**
* Returns the result of encoder.
*
* @param { string } [input] - The string to be encoded.
* @returns { Uint8Array } Returns the encoded text.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.util.encodeInto
*/
encode(input?: string): Uint8Array;
/**
* UTF-8 encodes the input string and returns a Uint8Array containing the encoded bytes.
*
* @param { string } [input] - The string to be encoded.
* @returns { Uint8Array } Returns the encoded text.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* UTF-8 encodes the input string and returns a Uint8Array containing the encoded bytes.
*
* @param { string } [input] - The string to be encoded.
* @returns { Uint8Array } Returns the encoded text.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* UTF-8 encodes the input string and returns a Uint8Array containing the encoded bytes.
*
* @param { string } [input] - The string to be encoded.
* @returns { Uint8Array } Returns the encoded text.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
encodeInto(input?: string): Uint8Array;
/**
* Encode string, write the result to dest array.
*
* @param { string } input - The string to be encoded.
* @param { Uint8Array } dest - Encoded numbers in accordance with the format
* @returns { object } Return the object, where read represents
* the number of characters that have been encoded, and written
* represents the number of bytes occupied by the encoded characters.
* @syscap SystemCapability.Utils.Lang
* @since 7
* @deprecated since 9
* @useinstead ohos.util.encodeIntoUint8Array
*/
encodeInto(input: string, dest: Uint8Array): { read: number; written: number };
/**
* Encode string, write the result to dest array.
*
* @param { string } input - The string to be encoded.
* @param { Uint8Array } dest - Encoded numbers in accordance with the format
* @returns { object } Return the object, where read represents
* the number of characters that have been encoded, and written
* represents the number of bytes occupied by the encoded characters.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Encode string, write the result to dest array.
*
* @param { string } input - The string to be encoded.
* @param { Uint8Array } dest - Encoded numbers in accordance with the format
* @returns { object } Return the object, where read represents
* the number of characters that have been encoded, and written
* represents the number of bytes occupied by the encoded characters.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Encode string, write the result to dest array.
*
* @param { string } input - The string to be encoded.
* @param { Uint8Array } dest - Encoded numbers in accordance with the format
* @returns { EncodeIntoUint8ArrayInfo } Return the object, where read represents
* the number of characters that have been encoded, and written
* represents the number of bytes occupied by the encoded characters.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
encodeIntoUint8Array(input: string, dest: Uint8Array): EncodeIntoUint8ArrayInfo;
}
/**
* The rational number is mainly to compare rational numbers and obtain the numerator and denominator.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The rational number is mainly to compare rational numbers and obtain the numerator and denominator.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The rational number is mainly to compare rational numbers and obtain the numerator and denominator.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
class RationalNumber {
/**
* A constructor used to create a RationalNumber instance with a given numerator and denominator.
*
* @param { number } numerator - An integer number
* @param { number } denominator - An integer number
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.RationalNumber.parseRationalNumber
*/
constructor(numerator: number, denominator: number);
/**
* A constructor used to create a RationalNumber instance with a given numerator and denominator.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* A constructor used to create a RationalNumber instance with a given numerator and denominator.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A constructor used to create a RationalNumber instance with a given numerator and denominator.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
constructor();
/**
* Used to create a RationalNumber instance with a given numerator and denominator.
*
* @param { number } numerator - An integer number
* @param { number } denominator - An integer number
* @returns { RationalNumber }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Used to create a RationalNumber instance with a given numerator and denominator.
*
* @param { number } numerator - An integer number
* @param { number } denominator - An integer number
* @returns { RationalNumber }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Used to create a RationalNumber instance with a given numerator and denominator.
*
* @param { number } numerator - An integer number
* @param { number } denominator - An integer number
* @returns { RationalNumber }
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static parseRationalNumber(numerator: number, denominator: number): RationalNumber;
/**
* Creates a RationalNumber object based on a given string.
*
* @param { string } rationalString - String Expression of Rational Numbers
* @returns { RationalNumber } Returns a RationalNumber object generated based on the given string.
* @throws { BusinessError } 401 - The type of rationalString must be string.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Creates a RationalNumber object based on a given string.
*
* @param { string } rationalString - String Expression of Rational Numbers
* @returns { RationalNumber } Returns a RationalNumber object generated based on the given string.
* @throws { BusinessError } 401 - The type of rationalString must be string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates a RationalNumber object based on a given string.
*
* @param { string } rationalString - String Expression of Rational Numbers
* @returns { RationalNumber } Returns a RationalNumber object generated based on the given string.
* @throws { BusinessError } 401 - The type of rationalString must be string.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static createRationalFromString(rationalString: string): RationalNumber;
/**
* Compares the current RationalNumber object to the given object.
*
* @param { RationalNumber } another - An object of other rational numbers
* @returns { number } Returns 0 or 1, or -1, depending on the comparison.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.compare
*/
compareTo(another: RationalNumber): number;
/**
* Compares the current RationalNumber object to the given object.
*
* @param { RationalNumber } another - An object of other rational numbers
* @returns { number } Returns 0 or 1, or -1, depending on the comparison.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Compares the current RationalNumber object to the given object.
*
* @param { RationalNumber } another - An object of other rational numbers
* @returns { number } Returns 0 or 1, or -1, depending on the comparison.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Compares the current RationalNumber object to the given object.
*
* @param { RationalNumber } another - An object of other rational numbers
* @returns { number } Returns 0 or 1, or -1, depending on the comparison.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
compare(another: RationalNumber): number;
/**
* Compares two objects for equality.
*
* @param { Object } obj - An object
* @returns { boolean } Returns true if the given object is the same as the current object; Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Compares two objects for equality.
*
* @param { Object } obj - An object
* @returns { boolean } Returns true if the given object is the same as the current object; Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Compares two objects for equality.
*
* @param { Object } obj - An object
* @returns { boolean } Returns true if the given object is the same as the current object; Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
equals(obj: Object): boolean;
/**
* Gets integer and floating-point values of a rational number object.
*
* @returns { number } Returns the integer and floating-point values of a rational number object.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets integer and floating-point values of a rational number object.
*
* @returns { number } Returns the integer and floating-point values of a rational number object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets integer and floating-point values of a rational number object.
*
* @returns { number } Returns the integer and floating-point values of a rational number object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
valueOf(): number;
/**
* Get the greatest common divisor of two integers.
*
* @param { number } number1 - Is an integer.
* @param { number } number2 - Is an integer.
* @returns { number } Returns the greatest common divisor of two integers, integer type.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.getCommonFactor
*/
static getCommonDivisor(number1: number, number2: number): number;
/**
* Get the greatest common factor of two integers.
*
* @param { number } number1 - Is an integer.
* @param { number } number2 - Is an integer.
* @returns { number } Returns the greatest common factor of two integers, integer type.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Get the greatest common factor of two integers.
*
* @param { number } number1 - Is an integer.
* @param { number } number2 - Is an integer.
* @returns { number } Returns the greatest common factor of two integers, integer type.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Get the greatest common factor of two integers.
*
* @param { number } number1 - Is an integer.
* @param { number } number2 - Is an integer.
* @returns { number } Returns the greatest common factor of two integers, integer type.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static getCommonFactor(number1: number, number2: number): number;
/**
* Gets the denominator of the current object.
*
* @returns { number } Returns the denominator of the current object.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the denominator of the current object.
*
* @returns { number } Returns the denominator of the current object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the denominator of the current object.
*
* @returns { number } Returns the denominator of the current object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getDenominator(): number;
/**
* Gets the numerator of the current object.
*
* @returns { number } Returns the numerator of the current object.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Gets the numerator of the current object.
*
* @returns { number } Returns the numerator of the current object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Gets the numerator of the current object.
*
* @returns { number } Returns the numerator of the current object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getNumerator(): number;
/**
* Checks whether the current RationalNumber object represents an infinite value.
*
* @returns { boolean } If the denominator is not 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Checks whether the current RationalNumber object represents an infinite value.
*
* @returns { boolean } If the denominator is not 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether the current RationalNumber object represents an infinite value.
*
* @returns { boolean } If the denominator is not 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isFinite(): boolean;
/**
* Checks whether the current RationalNumber object represents a Not-a-Number (NaN) value.
*
* @returns { boolean } If both the denominator and numerator are 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Checks whether the current RationalNumber object represents a Not-a-Number (NaN) value.
*
* @returns { boolean } If both the denominator and numerator are 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether the current RationalNumber object represents a Not-a-Number (NaN) value.
*
* @returns { boolean } If both the denominator and numerator are 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isNaN(): boolean;
/**
* Checks whether the current RationalNumber object represents the value 0.
*
* @returns { boolean } If the value represented by the current object is 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Checks whether the current RationalNumber object represents the value 0.
*
* @returns { boolean } If the value represented by the current object is 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether the current RationalNumber object represents the value 0.
*
* @returns { boolean } If the value represented by the current object is 0, true is returned. Otherwise, false is returned.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isZero(): boolean;
/**
* Obtains a string representation of the current RationalNumber object.
*
* @returns { string } Returns a string representation of the current RationalNumber object.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Obtains a string representation of the current RationalNumber object.
*
* @returns { string } Returns a string representation of the current RationalNumber object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains a string representation of the current RationalNumber object.
*
* @returns { string } Returns a string representation of the current RationalNumber object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
toString(): string;
}
/**
* The LruBuffer algorithm replaces the least used data with new data when the buffer space is insufficient.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache
*/
class LruBuffer<K, V> {
/**
* Default constructor used to create a new LruBuffer instance with the default capacity of 64.
*
* @param { number } capacity - Indicates the capacity to customize for the buffer.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.constructor
*/
constructor(capacity?: number);
/**
* Updates the buffer capacity to a specified capacity.
*
* @param { number } newCapacity - Indicates the new capacity to set.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.updateCapacity
*/
updateCapacity(newCapacity: number): void;
/**
* Returns a string representation of the object.
*
* @returns { string } Returns the string representation of the object and outputs the string representation of the object.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.toString
*/
toString(): string;
/**
* Obtains a list of all values in the current buffer.
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.length
*/
length: number;
/**
* Obtains the capacity of the current buffer.
*
* @returns { number } Returns the capacity of the current buffer.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.getCapacity
*/
getCapacity(): number;
/**
* Clears key-value pairs from the current buffer.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.clear
*/
clear(): void;
/**
* Obtains the number of times createDefault(Object) returned a value.
*
* @returns { number } Returns the number of times createDefault(java.lang.Object) returned a value.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.getCreateCount
*/
getCreateCount(): number;
/**
* Obtains the number of times that the queried values are not matched.
*
* @returns { number } Returns the number of times that the queried values are not matched.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.getMissCount
*/
getMissCount(): number;
/**
* Obtains the number of times that values are evicted from the buffer.
*
* @returns { number } Returns the number of times that values are evicted from the buffer.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.getRemovalCount
*/
getRemovalCount(): number;
/**
* Obtains the number of times that the queried values are successfully matched.
*
* @returns { number } Returns the number of times that the queried values are successfully matched.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.getMatchCount
*/
getMatchCount(): number;
/**
* Obtains the number of times that values are added to the buffer.
*
* @returns { number } Returns the number of times that values are added to the buffer.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.getPutCount
*/
getPutCount(): number;
/**
* Checks whether the current buffer is empty.
*
* @returns { boolean } Returns true if the current buffer contains no value.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.isEmpty
*/
isEmpty(): boolean;
/**
* Obtains the value associated with a specified key.
*
* @param { K } key - Indicates the key to query.
* @returns { V | undefined } Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.get
*/
get(key: K): V | undefined;
/**
* Adds a key-value pair to the buffer.
*
* @param { K } key - Indicates the key to add.
* @param { V } value - Indicates the value associated with the key to add.
* @returns { V } Returns the value associated with the added key; returns the original value if the key to add already exists.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.put
*/
put(key: K, value: V): V;
/**
* Obtains a list of all values in the current buffer.
*
* @returns { V[] } Returns the list of all values in the current buffer in ascending order, from the most recently accessed to least recently accessed.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.values
*/
values(): V[];
/**
* Obtains a list of keys for the values in the current buffer.
*
* @returns { K[] } Returns a list of keys sorted from most recently accessed to least recently accessed.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.keys
*/
keys(): K[];
/**
* Deletes a specified key and its associated value from the current buffer.
*
* @param { K } key - Indicates the key to delete.
* @returns { V | undefined } Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.remove
*/
remove(key: K): V | undefined;
/**
* Executes subsequent operations after a value is deleted.
*
* @param { boolean } isEvict - The parameter value is true if this method is called due to insufficient capacity,
* and the parameter value is false in other cases.
* @param { K } key - Indicates the deleted key.
* @param { V } value - Indicates the deleted value.
* @param { V } newValue - The parameter value is the new value associated if the put(java.lang.Object,java.lang.Object)
* method is called and the key to add already exists. The parameter value is null in other cases.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.afterRemoval
*/
afterRemoval(isEvict: boolean, key: K, value: V, newValue: V): void;
/**
* Checks whether the current buffer contains a specified key.
*
* @param { K } key - Indicates the key to check.
* @returns { boolean } Returns true if the buffer contains the specified key.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.contains
*/
contains(key: K): boolean;
/**
* Called after a cache miss to compute a value for the corresponding key.
*
* @param { K } key - Indicates the missed key.
* @returns { V } Returns the value associated with the key.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.createDefault
*/
createDefault(key: K): V;
/**
* Returns an array of key-value pairs of enumeratable properties of a given object.
*
* @returns { IterableIterator<[K, V]> } Returns an array of key-value pairs for the enumeratable properties of the given object itself.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.entries
*/
entries(): IterableIterator<[K, V]>;
/**
* Specifies the default iterator for an object.
* @returns { IterableIterator<[K, V]> } Returns a two - dimensional array in the form of key - value pairs.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.LRUCache.[Symbol.iterator]
*/
[Symbol.iterator](): IterableIterator<[K, V]>;
}
/**
* The LRUCache algorithm replaces the least used data with new data when the buffer space is insufficient.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The LRUCache algorithm replaces the least used data with new data when the buffer space is insufficient.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The LRUCache algorithm replaces the least used data with new data when the buffer space is insufficient.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
class LRUCache<K, V> {
/**
* Default constructor used to create a new LruBuffer instance with the default capacity of 64.
*
* @param { number } [capacity] - Indicates the capacity to customize for the buffer.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Default constructor used to create a new LruBuffer instance with the default capacity of 64.
*
* @param { number } [capacity] - Indicates the capacity to customize for the buffer.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Default constructor used to create a new LruBuffer instance with the default capacity of 64.
*
* @param { number } [capacity] - Indicates the capacity to customize for the buffer.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(capacity?: number);
/**
* Updates the buffer capacity to a specified capacity.
*
* @param { number } newCapacity - Indicates the new capacity to set.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Updates the buffer capacity to a specified capacity.
*
* @param { number } newCapacity - Indicates the new capacity to set.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Updates the buffer capacity to a specified capacity.
*
* @param { number } newCapacity - Indicates the new capacity to set.
* @throws { BusinessError } 401 - Parameter error. Possible causes: 1.Mandatory parameters are left unspecified.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
updateCapacity(newCapacity: number): void;
/**
* Returns a string representation of the object.
*
* @returns { string } Returns the string representation of the object and outputs the string representation of the object.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns a string representation of the object.
*
* @returns { string } Returns the string representation of the object and outputs the string representation of the object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns a string representation of the object.
*
* @returns { string } Returns the string representation of the object and outputs the string representation of the object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
toString(): string;
/**
* Obtains a list of all values in the current buffer.
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains a list of all values in the current buffer.
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains a list of all values in the current buffer.
*
* @type { number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
length: number;
/**
* Obtains the capacity of the current buffer.
*
* @returns { number } Returns the capacity of the current buffer.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the capacity of the current buffer.
*
* @returns { number } Returns the capacity of the current buffer.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the capacity of the current buffer.
*
* @returns { number } Returns the capacity of the current buffer.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getCapacity(): number;
/**
* Clears key-value pairs from the current buffer.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Clears key-value pairs from the current buffer.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Clears key-value pairs from the current buffer.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
clear(): void;
/**
* Obtains the number of times createDefault(Object) returned a value.
*
* @returns { number } Returns the number of times createDefault(java.lang.Object) returned a value.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the number of times createDefault(Object) returned a value.
*
* @returns { number } Returns the number of times createDefault(java.lang.Object) returned a value.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the number of times createDefault(Object) returned a value.
*
* @returns { number } Returns the number of times createDefault(java.lang.Object) returned a value.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getCreateCount(): number;
/**
* Obtains the number of times that the queried values are not matched.
*
* @returns { number } Returns the number of times that the queried values are not matched.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the number of times that the queried values are not matched.
*
* @returns { number } Returns the number of times that the queried values are not matched.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the number of times that the queried values are not matched.
*
* @returns { number } Returns the number of times that the queried values are not matched.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getMissCount(): number;
/**
* Obtains the number of times that values are evicted from the buffer.
*
* @returns { number } Returns the number of times that values are evicted from the buffer.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the number of times that values are evicted from the buffer.
*
* @returns { number } Returns the number of times that values are evicted from the buffer.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the number of times that values are evicted from the buffer.
*
* @returns { number } Returns the number of times that values are evicted from the buffer.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getRemovalCount(): number;
/**
* Obtains the number of times that the queried values are successfully matched.
*
* @returns { number } Returns the number of times that the queried values are successfully matched.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the number of times that the queried values are successfully matched.
*
* @returns { number } Returns the number of times that the queried values are successfully matched.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the number of times that the queried values are successfully matched.
*
* @returns { number } Returns the number of times that the queried values are successfully matched.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getMatchCount(): number;
/**
* Obtains the number of times that values are added to the buffer.
*
* @returns { number } Returns the number of times that values are added to the buffer.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the number of times that values are added to the buffer.
*
* @returns { number } Returns the number of times that values are added to the buffer.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the number of times that values are added to the buffer.
*
* @returns { number } Returns the number of times that values are added to the buffer.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getPutCount(): number;
/**
* Checks whether the current buffer is empty.
*
* @returns { boolean } Returns true if the current buffer contains no value.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Checks whether the current buffer is empty.
*
* @returns { boolean } Returns true if the current buffer contains no value.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether the current buffer is empty.
*
* @returns { boolean } Returns true if the current buffer contains no value.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isEmpty(): boolean;
/**
* Obtains the value associated with a specified key.
*
* @param { K } key - Indicates the key to query.
* @returns { V | undefined } Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the value associated with a specified key.
*
* @param { K } key - Indicates the key to query.
* @returns { V | undefined } Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the value associated with a specified key.
*
* @param { K } key - Indicates the key to query.
* @returns { V | undefined } Returns the value associated with the key if the specified key is present in the buffer; returns null otherwise.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
get(key: K): V | undefined;
/**
* Adds a key-value pair to the buffer.
*
* @param { K } key - Indicates the key to add.
* @param { V } value - Indicates the value associated with the key to add.
* @returns { V } Returns the value associated with the added key; returns the original value if the key to add already exists.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Adds a key-value pair to the buffer.
*
* @param { K } key - Indicates the key to add.
* @param { V } value - Indicates the value associated with the key to add.
* @returns { V } Returns the value associated with the added key; returns the original value if the key to add already exists.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Adds a key-value pair to the buffer.
*
* @param { K } key - Indicates the key to add.
* @param { V } value - Indicates the value associated with the key to add.
* @returns { V } Returns the value associated with the added key; returns the original value if the key to add already exists.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
put(key: K, value: V): V;
/**
* Obtains a list of all values in the current buffer.
*
* @returns { V[] } Returns the list of all values in the current buffer in ascending order, from the most recently accessed to least recently accessed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains a list of all values in the current buffer.
*
* @returns { V[] } Returns the list of all values in the current buffer in ascending order, from the most recently accessed to least recently accessed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains a list of all values in the current buffer.
*
* @returns { V[] } Returns the list of all values in the current buffer in ascending order, from the most recently accessed to least recently accessed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
values(): V[];
/**
* Obtains a list of keys for the values in the current buffer.
* since 9
*
* @returns { K[] } Returns a list of keys sorted from most recently accessed to least recently accessed.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains a list of keys for the values in the current buffer.
* since 9
*
* @returns { K[] } Returns a list of keys sorted from most recently accessed to least recently accessed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains a list of keys for the values in the current buffer.
* since 9
*
* @returns { K[] } Returns a list of keys sorted from most recently accessed to least recently accessed.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
keys(): K[];
/**
* Deletes a specified key and its associated value from the current buffer.
*
* @param { K } key - Indicates the key to delete.
* @returns { V | undefined } Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Deletes a specified key and its associated value from the current buffer.
*
* @param { K } key - Indicates the key to delete.
* @returns { V | undefined } Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Deletes a specified key and its associated value from the current buffer.
*
* @param { K } key - Indicates the key to delete.
* @returns { V | undefined } Returns an Optional object containing the deleted key-value pair; returns an empty Optional object if the key does not exist.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
remove(key: K): V | undefined;
/**
* Executes subsequent operations after a value is deleted.
*
* @param { boolean } isEvict - The parameter value is true if this method is called due to insufficient capacity,
* and the parameter value is false in other cases.
* @param { K } key - Indicates the deleted key.
* @param { V } value - Indicates the deleted value.
* @param { V } newValue - The parameter value is the new value associated if the put(java.lang.Object,java.lang.Object)
* method is called and the key to add already exists. The parameter value is null in other cases.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Executes subsequent operations after a value is deleted.
*
* @param { boolean } isEvict - The parameter value is true if this method is called due to insufficient capacity,
* and the parameter value is false in other cases.
* @param { K } key - Indicates the deleted key.
* @param { V } value - Indicates the deleted value.
* @param { V } newValue - The parameter value is the new value associated if the put(java.lang.Object,java.lang.Object)
* method is called and the key to add already exists. The parameter value is null in other cases.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Executes subsequent operations after a value is deleted.
*
* @param { boolean } isEvict - The parameter value is true if this method is called due to insufficient capacity,
* and the parameter value is false in other cases.
* @param { K } key - Indicates the deleted key.
* @param { V } value - Indicates the deleted value.
* @param { V } newValue - The parameter value is the new value associated if the put(java.lang.Object,java.lang.Object)
* method is called and the key to add already exists. The parameter value is null in other cases.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
afterRemoval(isEvict: boolean, key: K, value: V, newValue: V): void;
/**
* Checks whether the current buffer contains a specified key.
*
* @param { K } key - Indicates the key to check.
* @returns { boolean } Returns true if the buffer contains the specified key.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Checks whether the current buffer contains a specified key.
*
* @param { K } key - Indicates the key to check.
* @returns { boolean } Returns true if the buffer contains the specified key.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether the current buffer contains a specified key.
*
* @param { K } key - Indicates the key to check.
* @returns { boolean } Returns true if the buffer contains the specified key.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
contains(key: K): boolean;
/**
* Executes subsequent operations if miss to compute a value for the specific key.
*
* @param { K } key - Indicates the missed key.
* @returns { V } Returns the value associated with the key.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Executes subsequent operations if miss to compute a value for the specific key.
*
* @param { K } key - Indicates the missed key.
* @returns { V } Returns the value associated with the key.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Executes subsequent operations if miss to compute a value for the specific key.
*
* @param { K } key - Indicates the missed key.
* @returns { V } Returns the value associated with the key.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
createDefault(key: K): V;
/**
* Returns an array of key-value pairs of enumeratable properties of a given object.
*
* @returns { IterableIterator<[K, V]> } Returns an array of key-value pairs for the enumeratable properties of the given object itself.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns an array of key-value pairs of enumeratable properties of a given object.
*
* @returns { IterableIterator<[K, V]> } Returns an array of key-value pairs for the enumeratable properties of the given object itself.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns an array of key-value pairs of enumeratable properties of a given object.
*
* @returns { IterableIterator<[K, V]> } Returns an array of key-value pairs for the enumeratable properties of the given object itself.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
entries(): IterableIterator<[K, V]>;
/**
* Specifies the default iterator for an object.
*
* @returns { IterableIterator<[K, V]> } Returns a two - dimensional array in the form of key - value pairs.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Specifies the default iterator for an object.
*
* @returns { IterableIterator<[K, V]> } Returns a two - dimensional array in the form of key - value pairs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Specifies the default iterator for an object.
*
* @returns { IterableIterator<[K, V]> } Returns a two - dimensional array in the form of key - value pairs.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
[Symbol.iterator](): IterableIterator<[K, V]>;
}
/**
* The ScopeComparable contains comparison methods.
*
* @interface ScopeComparable
* @syscap SystemCapability.Utils.Lang
* @since 7
*/
/**
* The ScopeComparable contains comparison methods.
*
* @interface ScopeComparable
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The ScopeComparable contains comparison methods.
*
* @interface ScopeComparable
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
interface ScopeComparable {
/**
* The comparison function is used by the scope.
*
* @param { ScopeComparable } other - Other
* @returns { boolean } Returns whether the current object is greater than or equal to the input object.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The comparison function is used by the scope.
*
* @param { ScopeComparable } other - Other
* @returns { boolean } Returns whether the current object is greater than or equal to the input object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The comparison function is used by the scope.
*
* @param { ScopeComparable } other - Other
* @returns { boolean } Returns whether the current object is greater than or equal to the input object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
compareTo(other: ScopeComparable): boolean;
}
/**
* A type used to denote ScopeComparable or number.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* A type used to denote ScopeComparable or number.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A type used to denote ScopeComparable or number.
*
* @typedef { ScopeComparable | number }
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
type ScopeType = ScopeComparable | number;
/**
* The Scope interface is used to describe the valid range of a field.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper
*/
class Scope {
/**
* A constructor used to create a Scope instance with the lower and upper bounds specified.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.constructor
*/
constructor(lowerObj: ScopeType, upperObj: ScopeType);
/**
* Obtains a string representation of the current range.
*
* @returns { string } Returns a string representation of the current range object.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.toString
*/
toString(): string;
/**
* Returns the intersection of a given range and the current range.
*
* @param { Scope } range - A Scope range object
* @returns { Scope } Returns the intersection of a given range and the current range.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.intersect
*/
intersect(range: Scope): Scope;
/**
* Returns the intersection of the current range and the range specified by the given lower and upper bounds.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { Scope } Returns the intersection of the current range and the range specified by the given lower and upper bounds.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.intersect
*/
intersect(lowerObj: ScopeType, upperObj: ScopeType): Scope;
/**
* Obtains the upper bound of the current range.
*
* @returns { ScopeType } Returns the upper bound of the current range.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.getUpper
*/
getUpper(): ScopeType;
/**
* Obtains the lower bound of the current range.
*
* @returns { ScopeType } Returns the lower bound of the current range.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.getLower
*/
getLower(): ScopeType;
/**
* Creates the smallest range that includes the current range and the given lower and upper bounds.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { Scope } Returns the smallest range that includes the current range and the given lower and upper bounds.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.expand
*/
expand(lowerObj: ScopeType, upperObj: ScopeType): Scope;
/**
* Creates the smallest range that includes the current range and a given range.
*
* @param { Scope } range - A Scope range object
* @returns { Scope } Returns the smallest range that includes the current range and a given range.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.expand
*/
expand(range: Scope): Scope;
/**
* Creates the smallest range that includes the current range and a given value.
*
* @param { ScopeType } value - A ScopeType value
* @returns { Scope } Returns the smallest range that includes the current range and a given value.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.expand
*/
expand(value: ScopeType): Scope;
/**
* Checks whether a given value is within the current range.
*
* @param { ScopeType } value - A ScopeType value
* @returns { boolean } If the value is within the current range return true,otherwise return false.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.contains
*/
contains(value: ScopeType): boolean;
/**
* Checks whether a given range is within the current range.
*
* @param { Scope } range - A Scope range
* @returns { boolean } If the current range is within the given range return true,otherwise return false.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.contains
*/
contains(range: Scope): boolean;
/**
* Clamps a given value to the current range.
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeType } Returns a ScopeType object that a given value is clamped to the current range..
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.ScopeHelper.clamp
*/
clamp(value: ScopeType): ScopeType;
}
/**
* The ScopeHelper interface is used to describe the valid range of a field.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* The ScopeHelper interface is used to describe the valid range of a field.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The ScopeHelper interface is used to describe the valid range of a field.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
class ScopeHelper {
/**
* A constructor used to create a Scope instance with the lower and upper bounds specified.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* A constructor used to create a Scope instance with the lower and upper bounds specified.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* A constructor used to create a Scope instance with the lower and upper bounds specified.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(lowerObj: ScopeType, upperObj: ScopeType);
/**
* Obtains a string representation of the current range.
*
* @returns { string } Returns a string representation of the current range object.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains a string representation of the current range.
*
* @returns { string } Returns a string representation of the current range object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains a string representation of the current range.
*
* @returns { string } Returns a string representation of the current range object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
toString(): string;
/**
* Returns the intersection of a given range and the current range.
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the intersection of a given range and the current range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns the intersection of a given range and the current range.
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the intersection of a given range and the current range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns the intersection of a given range and the current range.
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the intersection of a given range and the current range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
intersect(range: ScopeHelper): ScopeHelper;
/**
* Returns the intersection of the current range and the range specified by the given lower and upper bounds.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { ScopeHelper } Returns the intersection of the current range and the range specified by the given lower and upper bounds.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Returns the intersection of the current range and the range specified by the given lower and upper bounds.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { ScopeHelper } Returns the intersection of the current range and the range specified by the given lower and upper bounds.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Returns the intersection of the current range and the range specified by the given lower and upper bounds.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { ScopeHelper } Returns the intersection of the current range and the range specified by the given lower and upper bounds.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
intersect(lowerObj: ScopeType, upperObj: ScopeType): ScopeHelper;
/**
* Obtains the upper bound of the current range.
*
* @returns { ScopeType } Returns the upper bound of the current range.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the upper bound of the current range.
*
* @returns { ScopeType } Returns the upper bound of the current range.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the upper bound of the current range.
*
* @returns { ScopeType } Returns the upper bound of the current range.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getUpper(): ScopeType;
/**
* Obtains the lower bound of the current range.
*
* @returns { ScopeType } Returns the lower bound of the current range.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Obtains the lower bound of the current range.
*
* @returns { ScopeType } Returns the lower bound of the current range.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Obtains the lower bound of the current range.
*
* @returns { ScopeType } Returns the lower bound of the current range.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
getLower(): ScopeType;
/**
* Creates the smallest range that includes the current range and the given lower and upper bounds.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { ScopeHelper } Returns the smallest range that includes the current range and the given lower and upper bounds.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates the smallest range that includes the current range and the given lower and upper bounds.
*
* @param { ScopeType } lowerObj - A ScopeType value
* @param { ScopeType } upperObj - A ScopeType value
* @returns { ScopeHelper } Returns the smallest range that includes the current range and the given lower and upper bounds.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @atomicservice
* @since 12
*/
expand(lowerObj: ScopeType, upperObj: ScopeType): ScopeHelper;
/**
* Creates the smallest range that includes the current range and a given range.
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates the smallest range that includes the current range and a given range.
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates the smallest range that includes the current range and a given range.
*
* @param { ScopeHelper } range - A Scope range object
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
expand(range: ScopeHelper): ScopeHelper;
/**
* Creates the smallest range that includes the current range and a given value.
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given value.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Creates the smallest range that includes the current range and a given value.
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given value.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Creates the smallest range that includes the current range and a given value.
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeHelper } Returns the smallest range that includes the current range and a given value.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
expand(value: ScopeType): ScopeHelper;
/**
* Checks whether a given value is within the current range.
*
* @param { ScopeType } value - A ScopeType value
* @returns { boolean } If the value is within the current range return true,otherwise return false.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Checks whether a given value is within the current range.
*
* @param { ScopeType } value - A ScopeType value
* @returns { boolean } If the value is within the current range return true,otherwise return false.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether a given value is within the current range.
*
* @param { ScopeType } value - A ScopeType value
* @returns { boolean } If the value is within the current range return true,otherwise return false.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
contains(value: ScopeType): boolean;
/**
* Checks whether a given range is within the current range.
*
* @param { ScopeHelper } range - A Scope range
* @returns { boolean } If the current range is within the given range return true,otherwise return false.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Checks whether a given range is within the current range.
*
* @param { ScopeHelper } range - A Scope range
* @returns { boolean } If the current range is within the given range return true,otherwise return false.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Checks whether a given range is within the current range.
*
* @param { ScopeHelper } range - A Scope range
* @returns { boolean } If the current range is within the given range return true,otherwise return false.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
contains(range: ScopeHelper): boolean;
/**
* Clamps a given value to the current range.
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeType } Returns a ScopeType object that a given value is clamped to the current range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Clamps a given value to the current range.
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeType } Returns a ScopeType object that a given value is clamped to the current range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Clamps a given value to the current range.
*
* @param { ScopeType } value - A ScopeType value
* @returns { ScopeType } Returns a ScopeType object that a given value is clamped to the current range.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
clamp(value: ScopeType): ScopeType;
}
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated
* u8 array using the Base64 encoding scheme.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.Base64Helper
*/
class Base64 {
/**
* Constructor for creating base64 encoding and decoding
*
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.Base64Helper.constructor
*/
constructor();
/**
* Encodes all bytes from the specified u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.Base64Helper.encodeSync
*/
encodeSync(src: Uint8Array): Uint8Array;
/**
* Encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { string } Return the encoded string.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.Base64Helper.encodeToStringSync
*/
encodeToStringSync(src: Uint8Array): string;
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @returns { Uint8Array } Return the decoded Uint8Array.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.Base64Helper.decodeSync
*/
decodeSync(src: Uint8Array | string): Uint8Array;
/**
* Asynchronously encodes all bytes in the specified u8 array into the newly allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.Base64Helper.encode
*/
encode(src: Uint8Array): Promise<Uint8Array>;
/**
* Asynchronously encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<string> } Returns the encoded asynchronous string.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.Base64Helper.encodeToString
*/
encodeToString(src: Uint8Array): Promise<string>;
/**
* Use the Base64 encoding scheme to asynchronously decode a Base64-encoded string or input u8 array into a newly allocated u8 array.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @returns { Promise<Uint8Array> } Return the decoded asynchronous Uint8Array.
* @syscap SystemCapability.Utils.Lang
* @since 8
* @deprecated since 9
* @useinstead ohos.util.Base64Helper.decode
*/
decode(src: Uint8Array | string): Promise<Uint8Array>;
}
/**
* The Type represents two different encoding formats for base64
*
* @enum { number } Type
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The Type represents two different encoding formats for base64
*
* @enum { number } Type
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* The Type represents four different encoding formats for base64
*
* @enum { number } Type
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
enum Type {
/**
* The value indicates that the encoding format of base64 is BASIC
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The value indicates that the encoding format of base64 is BASIC
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
BASIC,
/**
* The value indicates that the encoding format of base64 is MIME
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The value indicates that the encoding format of base64 is MIME
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
MIME,
/**
* The value indicates that the encoding format of base64 is BASIC_URL_SAFE
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
BASIC_URL_SAFE,
/**
* The value indicates that the encoding format of base64 is MIME_URL_SAFE
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
MIME_URL_SAFE
}
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated
* u8 array using the Base64 encoding scheme.
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated
* u8 array using the Base64 encoding scheme.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated
* u8 array using the Base64 encoding scheme.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
class Base64Helper {
/**
* Constructor for creating base64 encoding and decoding
*
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Constructor for creating base64 encoding and decoding
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Constructor for creating base64 encoding and decoding
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
constructor();
/**
* Encodes all bytes from the specified u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Encodes all bytes from the specified u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Encodes all bytes from the specified u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Encodes all bytes from the specified u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and BASIC_URL_SAFE
* @returns { Uint8Array } Return the encoded new Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodeSync(src: Uint8Array, options?: Type): Uint8Array;
/**
* Encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { string } Return the encoded string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { string } Return the encoded string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { string } Return the encoded string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } options - one of the Type enumeration
* @returns { string } Return the encoded string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodeToStringSync(src: Uint8Array, options?: Type): string;
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @returns { Uint8Array } Return the decoded Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { Uint8Array } Return the decoded Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { Uint8Array } Return the decoded Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Decodes a Base64 encoded String or input u8 array into a newly-allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - one of the Type enumeration
* @returns { Uint8Array } Return the decoded Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
decodeSync(src: Uint8Array | string, options?: Type): Uint8Array;
/**
* Asynchronously encodes all bytes in the specified u8 array into the newly allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Asynchronously encodes all bytes in the specified u8 array into the newly allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Asynchronously encodes all bytes in the specified u8 array into the newly allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 11
*/
/**
* Asynchronously encodes all bytes in the specified u8 array into the newly allocated u8 array using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and BASIC_URL_SAFE
* @returns { Promise<Uint8Array> } Return the encodes asynchronous new Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encode(src: Uint8Array, options?: Type): Promise<Uint8Array>;
/**
* Asynchronously encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @returns { Promise<string> } Returns the encoded asynchronous string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Asynchronously encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { Promise<string> } Returns the encoded asynchronous string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Asynchronously encodes the specified byte array into a String using the Base64 encoding scheme.
*
* @param { Uint8Array } src - A Uint8Array value
* @param { Type } [options] - one of the Type enumeration
* @returns { Promise<string> } Returns the encoded asynchronous string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
encodeToString(src: Uint8Array, options?: Type): Promise<string>;
/**
* Use the Base64 encoding scheme to asynchronously decode a Base64-encoded string or
* input u8 array into a newly allocated u8 array.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @returns { Promise<Uint8Array> } Return the decoded asynchronous Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @since 9
*/
/**
* Use the Base64 encoding scheme to asynchronously decode a Base64-encoded string or
* input u8 array into a newly allocated u8 array.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - Enumerating input parameters includes two encoding formats: BASIC and MIME
* @returns { Promise<Uint8Array> } Return the decoded asynchronous Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Use the Base64 encoding scheme to asynchronously decode a Base64-encoded string or
* input u8 array into a newly allocated u8 array.
*
* @param { Uint8Array | string } src - A Uint8Array value or value A string value
* @param { Type } [options] - one of the Type enumeration
* @returns { Promise<Uint8Array> } Return the decoded asynchronous Uint8Array.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
decode(src: Uint8Array | string, options?: Type): Promise<Uint8Array>;
}
/**
* Check the type of parameter.
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check the type of parameter.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check the type of parameter.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
class types {
/**
* The types constructor
*
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* The types constructor
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* The types constructor
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
constructor();
/**
* Check whether the entered value is of arraybuffer or sharedarraybuffer type.
*
* @param { Object } value - A ArrayBuffer or SharedArrayBuffer value
* @returns { boolean } Returns true if the value is a built-in ArrayBuffer or SharedArrayBuffer instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of arraybuffer or sharedarraybuffer type.
*
* @param { Object } value - A ArrayBuffer or SharedArrayBuffer value
* @returns { boolean } Returns true if the value is a built-in ArrayBuffer or SharedArrayBuffer instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of arraybuffer or sharedarraybuffer type.
*
* @param { Object } value - A ArrayBuffer or SharedArrayBuffer value
* @returns { boolean } Returns true if the value is a built-in ArrayBuffer or SharedArrayBuffer instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isAnyArrayBuffer(value: Object): boolean;
/**
* Check whether the type is included in the isAnyArrayBuffer.
*
* @param { Object } value - A included in the isAnyArrayBuffer value
* @returns { boolean } Returns true if the value is an instance of one of the ArrayBuffer views,
* such as typed array objects or DataView.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the type is included in the isAnyArrayBuffer.
*
* @param { Object } value - A included in the isAnyArrayBuffer value
* @returns { boolean } Returns true if the value is an instance of one of the ArrayBuffer views,
* such as typed array objects or DataView.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the type is included in the isAnyArrayBuffer.
*
* @param { Object } value - A included in the isAnyArrayBuffer value
* @returns { boolean } Returns true if the value is an instance of one of the ArrayBuffer views,
* such as typed array objects or DataView.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isArrayBufferView(value: Object): boolean;
/**
* Check whether the entered value is an arguments object type.
*
* @param { Object } value - A arguments value
* @returns { boolean } Returns true if the value is an arguments object.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is an arguments object type.
*
* @param { Object } value - A arguments value
* @returns { boolean } Returns true if the value is an arguments object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is an arguments object type.
*
* @param { Object } value - A arguments value
* @returns { boolean } Returns true if the value is an arguments object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isArgumentsObject(value: Object): boolean;
/**
* Check whether the entered value is of arraybuffer type.
*
* @param { Object } value - A arraybuffer value
* @returns { boolean } Returns true if the value is a built-in ArrayBuffer instance. This does not include SharedArrayBuffer instances.
* Usually, it is desirable to test for both; See isAnyArrayBuffer() for that.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of arraybuffer type.
*
* @param { Object } value - A arraybuffer value
* @returns { boolean } Returns true if the value is a built-in ArrayBuffer instance. This does not include SharedArrayBuffer instances.
* Usually, it is desirable to test for both; See isAnyArrayBuffer() for that.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of arraybuffer type.
*
* @param { Object } value - A arraybuffer value
* @returns { boolean } Returns true if the value is a built-in ArrayBuffer instance. This does not include SharedArrayBuffer instances.
* Usually, it is desirable to test for both; See isAnyArrayBuffer() for that.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isArrayBuffer(value: Object): boolean;
/**
* Check whether the value entered is an asynchronous function type.
*
* @param { Object } value - A async function value
* @returns { boolean } Returns true if the value is an async function. This only reports back what the JavaScript engine is seeing;
* in particular, the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the value entered is an asynchronous function type.
*
* @param { Object } value - A async function value
* @returns { boolean } Returns true if the value is an async function. This only reports back what the JavaScript engine is seeing;
* in particular, the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the value entered is an asynchronous function type.
*
* @param { Object } value - A async function value
* @returns { boolean } Returns true if the value is an async function. This only reports back what the JavaScript engine is seeing;
* in particular, the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isAsyncFunction(value: Object): boolean;
/**
* Check whether the entered value is of bigint64array array type.
*
* @param { Object } value - A BigInt64Array value
* @returns { boolean } Returns true if the value is a BigInt64Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of bigint64array array type.
*
* @param { Object } value - A BigInt64Array value
* @returns { boolean } Returns true if the value is a BigInt64Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of bigint64array array type.
*
* @param { Object } value - A BigInt64Array value
* @returns { boolean } Returns true if the value is a BigInt64Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isBigInt64Array(value: Object): boolean;
/**
* Check whether the entered value is of biguint64array array array type.
*
* @param { Object } value - A BigUint64Array value
* @returns { boolean } Returns true if the value is a BigUint64Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of biguint64array array array type.
*
* @param { Object } value - A BigUint64Array value
* @returns { boolean } Returns true if the value is a BigUint64Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of biguint64array array array type.
*
* @param { Object } value - A BigUint64Array value
* @returns { boolean } Returns true if the value is a BigUint64Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isBigUint64Array(value: Object): boolean;
/**
* Check whether the entered value is a Boolean object type.
*
* @param { Object } value - A boolean object value
* @returns { boolean } Returns true if the value is a boolean object, e.g. created by new Boolean().
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is a Boolean object type.
*
* @param { Object } value - A boolean object value
* @returns { boolean } Returns true if the value is a boolean object, e.g. created by new Boolean().
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is a Boolean object type.
*
* @param { Object } value - A boolean object value
* @returns { boolean } Returns true if the value is a boolean object, e.g. created by new Boolean().
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isBooleanObject(value: Object): boolean;
/**
* Check whether the entered value is a Boolean or number or string or symbol object type.
*
* @param { Object } value - A boxed primitive object value
* @returns { boolean } Returns true if the value is any boxed primitive object, e.g. created by new Boolean(), new String() or Object(Symbol()).
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is a Boolean or number or string or symbol object type.
*
* @param { Object } value - A boxed primitive object value
* @returns { boolean } Returns true if the value is any boxed primitive object, e.g. created by new Boolean(), new String() or Object(Symbol()).
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is a Boolean or number or string or symbol object type.
*
* @param { Object } value - A boxed primitive object value
* @returns { boolean } Returns true if the value is any boxed primitive object, e.g. created by new Boolean(), new String() or Object(Symbol()).
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isBoxedPrimitive(value: Object): boolean;
/**
* Check whether the entered value is of DataView type.
*
* @param { Object } value - A DataView value
* @returns { boolean } Returns true if the value is a built-in DataView instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of DataView type.
*
* @param { Object } value - A DataView value
* @returns { boolean } Returns true if the value is a built-in DataView instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of DataView type.
*
* @param { Object } value - A DataView value
* @returns { boolean } Returns true if the value is a built-in DataView instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isDataView(value: Object): boolean;
/**
* Check whether the entered value is of type date.
*
* @param { Object } value - A Date value
* @returns { boolean } Returns true if the value is a built-in Date instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of type date.
*
* @param { Object } value - A Date value
* @returns { boolean } Returns true if the value is a built-in Date instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of type date.
*
* @param { Object } value - A Date value
* @returns { boolean } Returns true if the value is a built-in Date instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isDate(value: Object): boolean;
/**
* Check whether the entered value is a native external value type.
*
* @param { Object } value - A External value
* @returns { boolean } Returns true if the value is a native External value.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is a native external value type.
*
* @param { Object } value - A External value
* @returns { boolean } Returns true if the value is a native External value.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is a native external value type.
*
* @param { Object } value - A External value
* @returns { boolean } Returns true if the value is a native External value.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isExternal(value: Object): boolean;
/**
* Check whether the entered value is of float32array array type.
*
* @param { Object } value - A Float32Array value
* @returns { boolean } Returns true if the value is a built-in Float32Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of float32array array type.
*
* @param { Object } value - A Float32Array value
* @returns { boolean } Returns true if the value is a built-in Float32Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of float32array array type.
*
* @param { Object } value - A Float32Array value
* @returns { boolean } Returns true if the value is a built-in Float32Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isFloat32Array(value: Object): boolean;
/**
* Check whether the entered value is of float64array array type.
*
* @param { Object } value - A Float64Array value
* @returns { boolean } Returns true if the value is a built-in Float64Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of float64array array type.
*
* @param { Object } value - A Float64Array value
* @returns { boolean } Returns true if the value is a built-in Float64Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of float64array array type.
*
* @param { Object } value - A Float64Array value
* @returns { boolean } Returns true if the value is a built-in Float64Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isFloat64Array(value: Object): boolean;
/**
* Check whether the input value is a generator function type.
*
* @param { Object } value - A generator function value
* @returns { boolean } Returns true if the value is a generator function. This only reports back what the JavaScript engine is seeing; in particular,
* the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the input value is a generator function type.
*
* @param { Object } value - A generator function value
* @returns { boolean } Returns true if the value is a generator function. This only reports back what the JavaScript engine is seeing; in particular,
* the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the input value is a generator function type.
*
* @param { Object } value - A generator function value
* @returns { boolean } Returns true if the value is a generator function. This only reports back what the JavaScript engine is seeing; in particular,
* the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isGeneratorFunction(value: Object): boolean;
/**
* Check whether the entered value is a generator object type.
*
* @param { Object } value - A generator object value
* @returns { boolean } Returns true if the value is a generator object as returned from a built-in generator function.
* This only reports back what the JavaScript engine is seeing; in particular,
*the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is a generator object type.
*
* @param { Object } value - A generator object value
* @returns { boolean } Returns true if the value is a generator object as returned from a built-in generator function.
* This only reports back what the JavaScript engine is seeing; in particular,
*the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is a generator object type.
*
* @param { Object } value - A generator object value
* @returns { boolean } Returns true if the value is a generator object as returned from a built-in generator function.
* This only reports back what the JavaScript engine is seeing; in particular,
*the return value may not match the original source code if a transpilation tool was used.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isGeneratorObject(value: Object): boolean;
/**
* Check whether the entered value is of int8array array type.
*
* @param { Object } value - A Int8Array value
* @returns { boolean } Returns true if the value is a built-in Int8Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of int8array array type.
*
* @param { Object } value - A Int8Array value
* @returns { boolean } Returns true if the value is a built-in Int8Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of int8array array type.
*
* @param { Object } value - A Int8Array value
* @returns { boolean } Returns true if the value is a built-in Int8Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isInt8Array(value: Object): boolean;
/**
* Check whether the entered value is the int16array type.
*
* @param { Object } value - A Int16Array value
* @returns { boolean } Returns true if the value is a built-in Int16Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the int16array type.
*
* @param { Object } value - A Int16Array value
* @returns { boolean } Returns true if the value is a built-in Int16Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the int16array type.
*
* @param { Object } value - A Int16Array value
* @returns { boolean } Returns true if the value is a built-in Int16Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isInt16Array(value: Object): boolean;
/**
* Check whether the entered value is the int32array array type.
*
* @param { Object } value - A Int32Array value
* @returns { boolean } Returns true if the value is a built-in Int32Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the int32array array type.
*
* @param { Object } value - A Int32Array value
* @returns { boolean } Returns true if the value is a built-in Int32Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the int32array array type.
*
* @param { Object } value - A Int32Array value
* @returns { boolean } Returns true if the value is a built-in Int32Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isInt32Array(value: Object): boolean;
/**
* Check whether the entered value is of map type.
*
* @param { Object } value - A Map value
* @returns { boolean } Returns true if the value is a built-in Map instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of map type.
*
* @param { Object } value - A Map value
* @returns { boolean } Returns true if the value is a built-in Map instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of map type.
*
* @param { Object } value - A Map value
* @returns { boolean } Returns true if the value is a built-in Map instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isMap(value: Object): boolean;
/**
* Check whether the entered value is the iterator type of map.
*
* @param { Object } value - A Map iterator value
* @returns { boolean } Returns true if the value is an iterator returned for a built-in Map instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the iterator type of map.
*
* @param { Object } value - A Map iterator value
* @returns { boolean } Returns true if the value is an iterator returned for a built-in Map instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the iterator type of map.
*
* @param { Object } value - A Map iterator value
* @returns { boolean } Returns true if the value is an iterator returned for a built-in Map instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isMapIterator(value: Object): boolean;
/**
* Check whether the entered value is the module namespace object object type.
*
* @param { Object } value - A Module Namespace Object value
* @returns { boolean } Returns true if the value is an instance of a Module Namespace Object.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the module namespace object object type.
*
* @param { Object } value - A Module Namespace Object value
* @returns { boolean } Returns true if the value is an instance of a Module Namespace Object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the module namespace object object type.
*
* @param { Object } value - A Module Namespace Object value
* @returns { boolean } Returns true if the value is an instance of a Module Namespace Object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isModuleNamespaceObject(value: Object): boolean;
/**
* Check whether the value entered is of type error.
*
* @param { Object } value - A Error value
* @returns { boolean } Returns true if the value is an instance of a built-in Error type.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the value entered is of type error.
*
* @param { Object } value - A Error value
* @returns { boolean } Returns true if the value is an instance of a built-in Error type.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the value entered is of type error.
*
* @param { Object } value - A Error value
* @returns { boolean } Returns true if the value is an instance of a built-in Error type.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isNativeError(value: Object): boolean;
/**
* Check whether the entered value is of the number object type.
*
* @param { Object } value - A number object value
* @returns { boolean } Returns true if the value is a number object, e.g. created by new Number().
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of the number object type.
*
* @param { Object } value - A number object value
* @returns { boolean } Returns true if the value is a number object, e.g. created by new Number().
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of the number object type.
*
* @param { Object } value - A number object value
* @returns { boolean } Returns true if the value is a number object, e.g. created by new Number().
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isNumberObject(value: Object): boolean;
/**
* Check whether the entered value is of promise type.
*
* @param { Object } value - A Promise value
* @returns { boolean } Returns true if the value is a built-in Promise.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of promise type.
*
* @param { Object } value - A Promise value
* @returns { boolean } Returns true if the value is a built-in Promise.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of promise type.
*
* @param { Object } value - A Promise value
* @returns { boolean } Returns true if the value is a built-in Promise.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isPromise(value: Object): boolean;
/**
* Check whether the value entered is of proxy type.
*
* @param { Object } value - A Proxy value
* @returns { boolean } Returns true if the value is a Proxy instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the value entered is of proxy type.
*
* @param { Object } value - A Proxy value
* @returns { boolean } Returns true if the value is a Proxy instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the value entered is of proxy type.
*
* @param { Object } value - A Proxy value
* @returns { boolean } Returns true if the value is a Proxy instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isProxy(value: Object): boolean;
/**
* Check whether the entered value is of type regexp.
*
* @param { Object } value - A regular expression object value
* @returns { boolean } Returns true if the value is a regular expression object.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of type regexp.
*
* @param { Object } value - A regular expression object value
* @returns { boolean } Returns true if the value is a regular expression object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of type regexp.
*
* @param { Object } value - A regular expression object value
* @returns { boolean } Returns true if the value is a regular expression object.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isRegExp(value: Object): boolean;
/**
* Check whether the entered value is of type set.
*
* @param { Object } value - A Set instance value
* @returns { boolean } Returns true if the value is a built-in Set instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of type set.
*
* @param { Object } value - A Set instance value
* @returns { boolean } Returns true if the value is a built-in Set instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of type set.
*
* @param { Object } value - A Set instance value
* @returns { boolean } Returns true if the value is a built-in Set instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isSet(value: Object): boolean;
/**
* Check whether the entered value is the iterator type of set.
*
* @param { Object } value - A Set iterator value
* @returns { boolean } Returns true if the value is an iterator returned for a built-in Set instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the iterator type of set.
*
* @param { Object } value - A Set iterator value
* @returns { boolean } Returns true if the value is an iterator returned for a built-in Set instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the iterator type of set.
*
* @param { Object } value - A Set iterator value
* @returns { boolean } Returns true if the value is an iterator returned for a built-in Set instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isSetIterator(value: Object): boolean;
/**
* Check whether the entered value is of type sharedarraybuffer.
*
* @param { Object } value - A SharedArrayBuffer instance value
* @returns { boolean } Returns true if the value is a built-in SharedArrayBuffer instance. This does not include ArrayBuffer instances.
* Usually, it is desirable to test for both; See isAnyArrayBuffer() for that.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of type sharedarraybuffer.
*
* @param { Object } value - A SharedArrayBuffer instance value
* @returns { boolean } Returns true if the value is a built-in SharedArrayBuffer instance. This does not include ArrayBuffer instances.
* Usually, it is desirable to test for both; See isAnyArrayBuffer() for that.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of type sharedarraybuffer.
*
* @param { Object } value - A SharedArrayBuffer instance value
* @returns { boolean } Returns true if the value is a built-in SharedArrayBuffer instance. This does not include ArrayBuffer instances.
* Usually, it is desirable to test for both; See isAnyArrayBuffer() for that.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isSharedArrayBuffer(value: Object): boolean;
/**
* Check whether the entered value is a string object type.
*
* @param { Object } value - A String object value
* @returns { boolean } Returns true if the value is a string object, e.g. created by new String().
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is a string object type.
*
* @param { Object } value - A String object value
* @returns { boolean } Returns true if the value is a string object, e.g. created by new String().
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is a string object type.
*
* @param { Object } value - A String object value
* @returns { boolean } Returns true if the value is a string object, e.g. created by new String().
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isStringObject(value: Object): boolean;
/**
* Check whether the entered value is a symbol object type.
*
* @param { Object } value - A symbol object value
* @returns { boolean } Returns true if the value is a symbol object, created by calling Object() on a Symbol primitive.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is a symbol object type.
*
* @param { Object } value - A symbol object value
* @returns { boolean } Returns true if the value is a symbol object, created by calling Object() on a Symbol primitive.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is a symbol object type.
*
* @param { Object } value - A symbol object value
* @returns { boolean } Returns true if the value is a symbol object, created by calling Object() on a Symbol primitive.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isSymbolObject(value: Object): boolean;
/**
* Check whether the entered value is a type contained in typedarray.
*
* @param { Object } value - A TypedArray instance value
* @returns { boolean } Returns true if the value is a built-in TypedArray instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is a type contained in typedarray.
*
* @param { Object } value - A TypedArray instance value
* @returns { boolean } Returns true if the value is a built-in TypedArray instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is a type contained in typedarray.
*
* @param { Object } value - A TypedArray instance value
* @returns { boolean } Returns true if the value is a built-in TypedArray instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isTypedArray(value: Object): boolean;
/**
* Check whether the entered value is the uint8array array type.
*
* @param { Object } value - A Uint8Array value
* @returns { boolean } Returns true if the value is a built-in Uint8Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the uint8array array type.
*
* @param { Object } value - A Uint8Array value
* @returns { boolean } Returns true if the value is a built-in Uint8Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the uint8array array type.
*
* @param { Object } value - A Uint8Array value
* @returns { boolean } Returns true if the value is a built-in Uint8Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isUint8Array(value: Object): boolean;
/**
* Check whether the entered value is the uint8clapedarray array type.
*
* @param { Object } value - A Uint8ClampedArray value
* @returns { boolean } Returns true if the value is a built-in Uint8ClampedArray instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the uint8clapedarray array type.
*
* @param { Object } value - A Uint8ClampedArray value
* @returns { boolean } Returns true if the value is a built-in Uint8ClampedArray instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the uint8clapedarray array type.
*
* @param { Object } value - A Uint8ClampedArray value
* @returns { boolean } Returns true if the value is a built-in Uint8ClampedArray instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isUint8ClampedArray(value: Object): boolean;
/**
* Check whether the entered value is the uint16array array array type.
*
* @param { Object } value - A Uint16Array value
* @returns { boolean } Returns true if the value is a built-in Uint16Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the uint16array array array type.
*
* @param { Object } value - A Uint16Array value
* @returns { boolean } Returns true if the value is a built-in Uint16Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the uint16array array array type.
*
* @param { Object } value - A Uint16Array value
* @returns { boolean } Returns true if the value is a built-in Uint16Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isUint16Array(value: Object): boolean;
/**
* Check whether the entered value is the uint32array array type.
*
* @param { Object } value - A Uint32Array value
* @returns { boolean } Returns true if the value is a built-in Uint32Array instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is the uint32array array type.
*
* @param { Object } value - A Uint32Array value
* @returns { boolean } Returns true if the value is a built-in Uint32Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is the uint32array array type.
*
* @param { Object } value - A Uint32Array value
* @returns { boolean } Returns true if the value is a built-in Uint32Array instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isUint32Array(value: Object): boolean;
/**
* Check whether the entered value is of type weakmap.
*
* @param { Object } value - A WeakMap value
* @returns { boolean } Returns true if the value is a built-in WeakMap instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of type weakmap.
*
* @param { Object } value - A WeakMap value
* @returns { boolean } Returns true if the value is a built-in WeakMap instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of type weakmap.
*
* @param { Object } value - A WeakMap value
* @returns { boolean } Returns true if the value is a built-in WeakMap instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isWeakMap(value: Object): boolean;
/**
* Check whether the entered value is of type weakset.
*
* @param { Object } value - A WeakSet value
* @returns { boolean } Returns true if the value is a built-in WeakSet instance.
* @syscap SystemCapability.Utils.Lang
* @since 8
*/
/**
* Check whether the entered value is of type weakset.
*
* @param { Object } value - A WeakSet value
* @returns { boolean } Returns true if the value is a built-in WeakSet instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 10
*/
/**
* Check whether the entered value is of type weakset.
*
* @param { Object } value - A WeakSet value
* @returns { boolean } Returns true if the value is a built-in WeakSet instance.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
isWeakSet(value: Object): boolean;
}
/**
* Insert before/after logic into a class method or replace implementation for a class method.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
*/
/**
* Insert before/after logic into a class method or replace implementation for a class method.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
class Aspect {
/**
* Insert some logic before the method. In implementation the method will be replaced with a new function,
* which will execute 'before' with the args 'this' and the args of the original method, and then execute
* the original method. The return value of the new function is returned by the original method.
*
* @param { Object } targetClass - The operated class.
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } before - The logic inserted before the method.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
*/
/**
* Insert some logic before the method. In implementation the method will be replaced with a new function,
* which will execute 'before' with the args 'this' and the args of the original method, and then execute
* the original method. The return value of the new function is returned by the original method.
*
* @param { Object } targetClass - The operated class.
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } before - The logic inserted before the method.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static addBefore(targetClass: Object, methodName: string, isStatic: boolean, before: Function): void;
/**
* Insert some logic after the method. In implementation the method will be replaced with a new function,
* which will execute the original method, and then execute 'after' with the args 'this' and the return value of
* the original method, and the args of the original method. The return value of the new function is returned by 'after'.
*
* @param { Object } targetClass - The operated class.
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } after - The logic inserted after the method.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
*/
/**
* Insert some logic after the method. In implementation the method will be replaced with a new function,
* which will execute the original method, and then execute 'after' with the args 'this' and the return value of
* the original method, and the args of the original method. The return value of the new function is returned by 'after'.
*
* @param { Object } targetClass - The operated class.
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } after - The logic inserted after the method.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static addAfter(targetClass: Object, methodName: string, isStatic: boolean, after: Function): void;
/**
* Replace the original method with a new function, which will execute 'instead' with the args 'this' and the args
* of the original method. The return value of the new function is returned by 'instead'.
*
* @param { Object } targetClass - The operated class.
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } instead - The logic replaced with the method.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @since 11
*/
/**
* Replace the original method with a new function, which will execute 'instead' with the args 'this' and the args
* of the original method. The return value of the new function is returned by 'instead'.
*
* @param { Object } targetClass - The operated class.
* @param { string } methodName - The name of the operated method.
* @param { boolean } isStatic - The flag whether the method is static.
* @param { Function } instead - The logic replaced with the method.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types.
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
static replace(targetClass: Object, methodName: string, isStatic: boolean, instead: Function) : void;
}
/**
* Provide the ability to decode binary streams into strings. The supported encoding types include: utf-8, iso-8859-2,
* koi8-r, macintosh, windows-1250, windows-1251, gbk, gb18030, big5, utf-16be, utf-16 le, etc.
*
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
class StringDecoder {
/**
* The StringDecoder constructor.
*
* @param { string } [encoding] - Encoding type of the input data.Default: utf8.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
constructor(encoding?: string);
/**
* Returns a decoded string, ensuring that any incomplete multiple byte characters at the end of the Uint8Array are
* omitted from the returned string and stored in an internal buffer.
*
* @param { string | Uint8Array } chunk - The bytes to decode.
* @returns { string } Returns a decoded string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
write(chunk: string | Uint8Array): string;
/**
* Returns any remaining input stored in the internal buffer as a string. After end() is called,
* this object can be reused for new input.
*
* @param { string | Uint8Array } [chunk] - The bytes to decode.
* @returns { string } Returns any remaining input stored in the internal buffer as a string.
* @throws { BusinessError } 401 - Parameter error. Possible causes:
* 1.Mandatory parameters are left unspecified;
* 2.Incorrect parameter types;
* @syscap SystemCapability.Utils.Lang
* @crossplatform
* @atomicservice
* @since 12
*/
end(chunk?: string | Uint8Array): string;
}
}
export default util;
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

搜索帮助