1/* 2 * Copyright (c) 2021-2022 Huawei Device Co., Ltd. 3 * Licensed under the Apache License, Version 2.0 (the "License"); 4 * you may not use this file except in compliance with the License. 5 * You may obtain a copy of the License at 6 * 7 * http://www.apache.org/licenses/LICENSE-2.0 8 * 9 * Unless required by applicable law or agreed to in writing, software 10 * distributed under the License is distributed on an "AS IS" BASIS, 11 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 12 * See the License for the specific language governing permissions and 13 * limitations under the License. 14 */ 15 16/** 17 * @file 18 * @kit ArkTS 19 */ 20 21/** 22 * LightWeightMap stores key-value (KV) pairs. Each key must be unique and have only one value. 23 * 24 * @syscap SystemCapability.Utils.Lang 25 * @since 8 26 */ 27/** 28 * LightWeightMap stores key-value (KV) pairs. Each key must be unique and have only one value. 29 * 30 * @syscap SystemCapability.Utils.Lang 31 * @crossplatform 32 * @since 10 33 */ 34/** 35 * LightWeightMap stores key-value (KV) pairs. Each key must be unique and have only one value. 36 * 37 * @syscap SystemCapability.Utils.Lang 38 * @crossplatform 39 * @atomicservice 40 * @since 12 41 */ 42declare class LightWeightMap<K, V> { 43 /** 44 * A constructor used to create a LightWeightMap object. 45 * 46 * @throws { BusinessError } 10200012 - The LightWeightMap's constructor cannot be directly invoked. 47 * @syscap SystemCapability.Utils.Lang 48 * @since 8 49 */ 50 /** 51 * A constructor used to create a LightWeightMap object. 52 * 53 * @throws { BusinessError } 10200012 - The LightWeightMap's constructor cannot be directly invoked. 54 * @syscap SystemCapability.Utils.Lang 55 * @crossplatform 56 * @since 10 57 */ 58 /** 59 * A constructor used to create a LightWeightMap object. 60 * 61 * @throws { BusinessError } 10200012 - The LightWeightMap's constructor cannot be directly invoked. 62 * @syscap SystemCapability.Utils.Lang 63 * @crossplatform 64 * @atomicservice 65 * @since 12 66 */ 67 constructor(); 68 /** 69 * Gets the element number of the LightWeightMap. 70 * 71 * @type { number } 72 * @syscap SystemCapability.Utils.Lang 73 * @since 8 74 */ 75 /** 76 * Gets the element number of the LightWeightMap. 77 * 78 * @type { number } 79 * @syscap SystemCapability.Utils.Lang 80 * @crossplatform 81 * @since 10 82 */ 83 /** 84 * Gets the element number of the LightWeightMap. 85 * 86 * @type { number } 87 * @syscap SystemCapability.Utils.Lang 88 * @crossplatform 89 * @atomicservice 90 * @since 12 91 */ 92 length: number; 93 /** 94 * Returns whether this map has all the object in a specified map 95 * 96 * @param { LightWeightMap<K, V> } map - map map the Map object to compare 97 * @returns { boolean } the boolean type 98 * @throws { BusinessError } 401 - Parameter error. Possible causes: 99 * 1.Mandatory parameters are left unspecified; 100 * 2.Incorrect parameter types. 101 * @throws { BusinessError } 10200011 - The hasAll method cannot be bound. 102 * @syscap SystemCapability.Utils.Lang 103 * @since 8 104 */ 105 /** 106 * Returns whether this map has all the object in a specified map 107 * 108 * @param { LightWeightMap<K, V> } map - map map the Map object to compare 109 * @returns { boolean } the boolean type 110 * @throws { BusinessError } 401 - Parameter error. Possible causes: 111 * 1.Mandatory parameters are left unspecified; 112 * 2.Incorrect parameter types. 113 * @throws { BusinessError } 10200011 - The hasAll method cannot be bound. 114 * @syscap SystemCapability.Utils.Lang 115 * @crossplatform 116 * @since 10 117 */ 118 /** 119 * Returns whether this map has all the object in a specified map 120 * 121 * @param { LightWeightMap<K, V> } map - map map the Map object to compare 122 * @returns { boolean } the boolean type 123 * @throws { BusinessError } 401 - Parameter error. Possible causes: 124 * 1.Mandatory parameters are left unspecified; 125 * 2.Incorrect parameter types. 126 * @throws { BusinessError } 10200011 - The hasAll method cannot be bound. 127 * @syscap SystemCapability.Utils.Lang 128 * @crossplatform 129 * @atomicservice 130 * @since 12 131 */ 132 hasAll(map: LightWeightMap<K, V>): boolean; 133 /** 134 * Returns whether a key is contained in this map 135 * 136 * @param { K } key - key key need to determine whether to include the key 137 * @returns { boolean } the boolean type 138 * @throws { BusinessError } 10200011 - The hasKey method cannot be bound. 139 * @syscap SystemCapability.Utils.Lang 140 * @since 8 141 */ 142 /** 143 * Returns whether a key is contained in this map 144 * 145 * @param { K } key - key key need to determine whether to include the key 146 * @returns { boolean } the boolean type 147 * @throws { BusinessError } 10200011 - The hasKey method cannot be bound. 148 * @syscap SystemCapability.Utils.Lang 149 * @crossplatform 150 * @since 10 151 */ 152 /** 153 * Returns whether a key is contained in this map 154 * 155 * @param { K } key - key key need to determine whether to include the key 156 * @returns { boolean } the boolean type 157 * @throws { BusinessError } 10200011 - The hasKey method cannot be bound. 158 * @syscap SystemCapability.Utils.Lang 159 * @crossplatform 160 * @atomicservice 161 * @since 12 162 */ 163 hasKey(key: K): boolean; 164 /** 165 * Returns whether a value is contained in this map 166 * 167 * @param { V } value - value value need to determine whether to include the value 168 * @returns { boolean } the boolean type 169 * @throws { BusinessError } 10200011 - The hasValue method cannot be bound. 170 * @syscap SystemCapability.Utils.Lang 171 * @since 8 172 */ 173 /** 174 * Returns whether a value is contained in this map 175 * 176 * @param { V } value - value value need to determine whether to include the value 177 * @returns { boolean } the boolean type 178 * @throws { BusinessError } 10200011 - The hasValue method cannot be bound. 179 * @syscap SystemCapability.Utils.Lang 180 * @crossplatform 181 * @since 10 182 */ 183 /** 184 * Returns whether a value is contained in this map 185 * 186 * @param { V } value - value value need to determine whether to include the value 187 * @returns { boolean } the boolean type 188 * @throws { BusinessError } 10200011 - The hasValue method cannot be bound. 189 * @syscap SystemCapability.Utils.Lang 190 * @crossplatform 191 * @atomicservice 192 * @since 12 193 */ 194 hasValue(value: V): boolean; 195 /** 196 * Ensures that the capacity of an LightWeightMap container is greater than or equal to a specified value, 197 * and that the container has all the original objects after capacity expansion 198 * 199 * @param { number } minimumCapacity - minimumCapacity minimumCapacity Minimum capacity to be reserved 200 * @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound. 201 * @throws { BusinessError } 401 - Parameter error. Possible causes: 202 * 1.Mandatory parameters are left unspecified; 203 * 2.Incorrect parameter types. 204 * @syscap SystemCapability.Utils.Lang 205 * @since 8 206 */ 207 /** 208 * Ensures that the capacity of an LightWeightMap container is greater than or equal to a specified value, 209 * and that the container has all the original objects after capacity expansion 210 * 211 * @param { number } minimumCapacity - minimumCapacity minimumCapacity Minimum capacity to be reserved 212 * @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound. 213 * @throws { BusinessError } 401 - Parameter error. Possible causes: 214 * 1.Mandatory parameters are left unspecified; 215 * 2.Incorrect parameter types. 216 * @syscap SystemCapability.Utils.Lang 217 * @crossplatform 218 * @since 10 219 */ 220 /** 221 * Ensures that the capacity of an LightWeightMap container is greater than or equal to a specified value, 222 * and that the container has all the original objects after capacity expansion 223 * 224 * @param { number } minimumCapacity - minimumCapacity minimumCapacity Minimum capacity to be reserved 225 * @throws { BusinessError } 10200011 - The increaseCapacityTo method cannot be bound. 226 * @throws { BusinessError } 401 - Parameter error. Possible causes: 227 * 1.Mandatory parameters are left unspecified; 228 * 2.Incorrect parameter types. 229 * @syscap SystemCapability.Utils.Lang 230 * @crossplatform 231 * @atomicservice 232 * @since 12 233 */ 234 increaseCapacityTo(minimumCapacity: number): void; 235 /** 236 * Returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order 237 * 238 * @returns { IterableIterator<[K, V]> } 239 * @throws { BusinessError } 10200011 - The entries method cannot be bound. 240 * @syscap SystemCapability.Utils.Lang 241 * @since 8 242 */ 243 /** 244 * Returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order 245 * 246 * @returns { IterableIterator<[K, V]> } 247 * @throws { BusinessError } 10200011 - The entries method cannot be bound. 248 * @syscap SystemCapability.Utils.Lang 249 * @crossplatform 250 * @since 10 251 */ 252 /** 253 * Returns a new Iterator object that contains the [key, value] pairs for each element in the Map object in insertion order 254 * 255 * @returns { IterableIterator<[K, V]> } 256 * @throws { BusinessError } 10200011 - The entries method cannot be bound. 257 * @syscap SystemCapability.Utils.Lang 258 * @crossplatform 259 * @atomicservice 260 * @since 12 261 */ 262 entries(): IterableIterator<[K, V]>; 263 /** 264 * Returns the value to which the specified key is mapped, or undefined if this map contains no mapping for the key 265 * 266 * @param { K } key - key key the index in LightWeightMap 267 * @returns { V } value or undefined 268 * @throws { BusinessError } 10200011 - The get method cannot be bound. 269 * @syscap SystemCapability.Utils.Lang 270 * @since 8 271 */ 272 /** 273 * Returns the value to which the specified key is mapped, or undefined if this map contains no mapping for the key 274 * 275 * @param { K } key - key key the index in LightWeightMap 276 * @returns { V } value or undefined 277 * @throws { BusinessError } 10200011 - The get method cannot be bound. 278 * @syscap SystemCapability.Utils.Lang 279 * @crossplatform 280 * @since 10 281 */ 282 /** 283 * Returns the value to which the specified key is mapped, or undefined if this map contains no mapping for the key 284 * 285 * @param { K } key - key key the index in LightWeightMap 286 * @returns { V } value or undefined 287 * @throws { BusinessError } 10200011 - The get method cannot be bound. 288 * @syscap SystemCapability.Utils.Lang 289 * @crossplatform 290 * @atomicservice 291 * @since 12 292 */ 293 get(key: K): V; 294 /** 295 * Obtains the index of the key equal to a specified key in an LightWeightMap container 296 * 297 * @param { K } key - key key Looking for goals 298 * @returns { number } Subscript corresponding to target 299 * @throws { BusinessError } 10200011 - The getIndexOfKey method cannot be bound. 300 * @syscap SystemCapability.Utils.Lang 301 * @since 8 302 */ 303 /** 304 * Obtains the index of the key equal to a specified key in an LightWeightMap container 305 * 306 * @param { K } key - key key Looking for goals 307 * @returns { number } Subscript corresponding to target 308 * @throws { BusinessError } 10200011 - The getIndexOfKey method cannot be bound. 309 * @syscap SystemCapability.Utils.Lang 310 * @crossplatform 311 * @since 10 312 */ 313 /** 314 * Obtains the index of the key equal to a specified key in an LightWeightMap container 315 * 316 * @param { K } key - key key Looking for goals 317 * @returns { number } Subscript corresponding to target 318 * @throws { BusinessError } 10200011 - The getIndexOfKey method cannot be bound. 319 * @syscap SystemCapability.Utils.Lang 320 * @crossplatform 321 * @atomicservice 322 * @since 12 323 */ 324 getIndexOfKey(key: K): number; 325 /** 326 * Obtains the index of the value equal to a specified value in an LightWeightMap container 327 * 328 * @param { V } value - value value Looking for goals 329 * @returns { number } Subscript corresponding to target 330 * @throws { BusinessError } 10200011 - The getIndexOfValue method cannot be bound. 331 * @syscap SystemCapability.Utils.Lang 332 * @since 8 333 */ 334 /** 335 * Obtains the index of the value equal to a specified value in an LightWeightMap container 336 * 337 * @param { V } value - value value Looking for goals 338 * @returns { number } Subscript corresponding to target 339 * @throws { BusinessError } 10200011 - The getIndexOfValue method cannot be bound. 340 * @syscap SystemCapability.Utils.Lang 341 * @crossplatform 342 * @since 10 343 */ 344 /** 345 * Obtains the index of the value equal to a specified value in an LightWeightMap container 346 * 347 * @param { V } value - value value Looking for goals 348 * @returns { number } Subscript corresponding to target 349 * @throws { BusinessError } 10200011 - The getIndexOfValue method cannot be bound. 350 * @syscap SystemCapability.Utils.Lang 351 * @crossplatform 352 * @atomicservice 353 * @since 12 354 */ 355 getIndexOfValue(value: V): number; 356 /** 357 * Returns whether the Map object contains elements 358 * 359 * @returns { boolean } the boolean type 360 * @throws { BusinessError } 10200011 - The isEmpty method cannot be bound. 361 * @syscap SystemCapability.Utils.Lang 362 * @since 8 363 */ 364 /** 365 * Returns whether the Map object contains elements 366 * 367 * @returns { boolean } the boolean type 368 * @throws { BusinessError } 10200011 - The isEmpty method cannot be bound. 369 * @syscap SystemCapability.Utils.Lang 370 * @crossplatform 371 * @since 10 372 */ 373 /** 374 * Returns whether the Map object contains elements 375 * 376 * @returns { boolean } the boolean type 377 * @throws { BusinessError } 10200011 - The isEmpty method cannot be bound. 378 * @syscap SystemCapability.Utils.Lang 379 * @crossplatform 380 * @atomicservice 381 * @since 12 382 */ 383 isEmpty(): boolean; 384 /** 385 * Obtains the key at the location identified by index in an LightWeightMap container 386 * 387 * @param { number } index - index index Target subscript for search 388 * @returns { K } the key of key-value pairs 389 * @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound. 390 * @throws { BusinessError } 10200001 - The value of index is out of range. 391 * @throws { BusinessError } 401 - Parameter error. Possible causes: 392 * 1.Mandatory parameters are left unspecified; 393 * 2.Incorrect parameter types; 394 * 3.Parameter verification failed. 395 * @syscap SystemCapability.Utils.Lang 396 * @since 8 397 */ 398 /** 399 * Obtains the key at the location identified by index in an LightWeightMap container 400 * 401 * @param { number } index - index index Target subscript for search 402 * @returns { K } the key of key-value pairs 403 * @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound. 404 * @throws { BusinessError } 10200001 - The value of index is out of range. 405 * @throws { BusinessError } 401 - Parameter error. Possible causes: 406 * 1.Mandatory parameters are left unspecified; 407 * 2.Incorrect parameter types; 408 * 3.Parameter verification failed. 409 * @syscap SystemCapability.Utils.Lang 410 * @crossplatform 411 * @since 10 412 */ 413 /** 414 * Obtains the key at the location identified by index in an LightWeightMap container 415 * 416 * @param { number } index - index index Target subscript for search 417 * @returns { K } the key of key-value pairs 418 * @throws { BusinessError } 10200011 - The getKeyAt method cannot be bound. 419 * @throws { BusinessError } 10200001 - The value of index is out of range. 420 * @throws { BusinessError } 401 - Parameter error. Possible causes: 421 * 1.Mandatory parameters are left unspecified; 422 * 2.Incorrect parameter types; 423 * 3.Parameter verification failed. 424 * @syscap SystemCapability.Utils.Lang 425 * @crossplatform 426 * @atomicservice 427 * @since 12 428 */ 429 getKeyAt(index: number): K; 430 /** 431 * Obtains a ES6 iterator that contains all the keys of an LightWeightMap container 432 * 433 * @returns { IterableIterator<K> } 434 * @throws { BusinessError } 10200011 - The keys method cannot be bound. 435 * @syscap SystemCapability.Utils.Lang 436 * @since 8 437 */ 438 /** 439 * Obtains a ES6 iterator that contains all the keys of an LightWeightMap container 440 * 441 * @returns { IterableIterator<K> } 442 * @throws { BusinessError } 10200011 - The keys method cannot be bound. 443 * @syscap SystemCapability.Utils.Lang 444 * @crossplatform 445 * @since 10 446 */ 447 /** 448 * Obtains a ES6 iterator that contains all the keys of an LightWeightMap container 449 * 450 * @returns { IterableIterator<K> } 451 * @throws { BusinessError } 10200011 - The keys method cannot be bound. 452 * @syscap SystemCapability.Utils.Lang 453 * @crossplatform 454 * @atomicservice 455 * @since 12 456 */ 457 keys(): IterableIterator<K>; 458 /** 459 * Adds all element groups in one map to another map 460 * 461 * @param { LightWeightMap<K, V> } map - map map the Map object to add members 462 * @throws { BusinessError } 10200011 - The setAll method cannot be bound. 463 * @throws { BusinessError } 401 - Parameter error. Possible causes: 464 * 1.Mandatory parameters are left unspecified; 465 * 2.Incorrect parameter types. 466 * @syscap SystemCapability.Utils.Lang 467 * @since 8 468 */ 469 /** 470 * Adds all element groups in one map to another map 471 * 472 * @param { LightWeightMap<K, V> } map - map map the Map object to add members 473 * @throws { BusinessError } 10200011 - The setAll method cannot be bound. 474 * @throws { BusinessError } 401 - Parameter error. Possible causes: 475 * 1.Mandatory parameters are left unspecified; 476 * 2.Incorrect parameter types. 477 * @syscap SystemCapability.Utils.Lang 478 * @crossplatform 479 * @since 10 480 */ 481 /** 482 * Adds all element groups in one map to another map 483 * 484 * @param { LightWeightMap<K, V> } map - map map the Map object to add members 485 * @throws { BusinessError } 10200011 - The setAll method cannot be bound. 486 * @throws { BusinessError } 401 - Parameter error. Possible causes: 487 * 1.Mandatory parameters are left unspecified; 488 * 2.Incorrect parameter types. 489 * @syscap SystemCapability.Utils.Lang 490 * @crossplatform 491 * @atomicservice 492 * @since 12 493 */ 494 setAll(map: LightWeightMap<K, V>): void; 495 /** 496 * Adds or updates a(new) key-value pair with a key and value specified for the Map object 497 * 498 * @param { K } key - key key Added or updated targets 499 * @param { V } value - value Added or updated value 500 * @returns { Object } the map object after set 501 * @throws { BusinessError } 10200011 - The set method cannot be bound. 502 * @syscap SystemCapability.Utils.Lang 503 * @since 8 504 */ 505 /** 506 * Adds or updates a(new) key-value pair with a key and value specified for the Map object 507 * 508 * @param { K } key - key key Added or updated targets 509 * @param { V } value - value Added or updated value 510 * @returns { Object } the map object after set 511 * @throws { BusinessError } 10200011 - The set method cannot be bound. 512 * @syscap SystemCapability.Utils.Lang 513 * @crossplatform 514 * @since 10 515 */ 516 /** 517 * Adds or updates a(new) key-value pair with a key and value specified for the Map object 518 * 519 * @param { K } key - key key Added or updated targets 520 * @param { V } value - value Added or updated value 521 * @returns { Object } the map object after set 522 * @throws { BusinessError } 10200011 - The set method cannot be bound. 523 * @syscap SystemCapability.Utils.Lang 524 * @crossplatform 525 * @atomicservice 526 * @since 12 527 */ 528 set(key: K, value: V): Object; 529 /** 530 * Remove the mapping for this key from this map if present 531 * 532 * @param { K } key - key key Target to be deleted 533 * @returns { V } Target mapped value 534 * @throws { BusinessError } 10200011 - The remove method cannot be bound. 535 * @syscap SystemCapability.Utils.Lang 536 * @since 8 537 */ 538 /** 539 * Remove the mapping for this key from this map if present 540 * 541 * @param { K } key - key key Target to be deleted 542 * @returns { V } Target mapped value 543 * @throws { BusinessError } 10200011 - The remove method cannot be bound. 544 * @syscap SystemCapability.Utils.Lang 545 * @crossplatform 546 * @since 10 547 */ 548 /** 549 * Remove the mapping for this key from this map if present 550 * 551 * @param { K } key - key key Target to be deleted 552 * @returns { V } Target mapped value 553 * @throws { BusinessError } 10200011 - The remove method cannot be bound. 554 * @syscap SystemCapability.Utils.Lang 555 * @crossplatform 556 * @atomicservice 557 * @since 12 558 */ 559 remove(key: K): V; 560 /** 561 * Deletes a key-value pair at the location identified by index from an LightWeightMap container 562 * 563 * @param { number } index - index index Target subscript for search 564 * @returns { boolean } the boolean type(Is there a delete value) 565 * @throws { BusinessError } 10200011 - The removeAt method cannot be bound. 566 * @throws { BusinessError } 401 - Parameter error. Possible causes: 567 * 1.Mandatory parameters are left unspecified; 568 * 2.Incorrect parameter types. 569 * @syscap SystemCapability.Utils.Lang 570 * @since 8 571 */ 572 /** 573 * Deletes a key-value pair at the location identified by index from an LightWeightMap container 574 * 575 * @param { number } index - index index Target subscript for search 576 * @returns { boolean } the boolean type(Is there a delete value) 577 * @throws { BusinessError } 10200011 - The removeAt method cannot be bound. 578 * @throws { BusinessError } 401 - Parameter error. Possible causes: 579 * 1.Mandatory parameters are left unspecified; 580 * 2.Incorrect parameter types. 581 * @syscap SystemCapability.Utils.Lang 582 * @crossplatform 583 * @since 10 584 */ 585 /** 586 * Deletes a key-value pair at the location identified by index from an LightWeightMap container 587 * 588 * @param { number } index - index index Target subscript for search 589 * @returns { boolean } the boolean type(Is there a delete value) 590 * @throws { BusinessError } 10200011 - The removeAt method cannot be bound. 591 * @throws { BusinessError } 401 - Parameter error. Possible causes: 592 * 1.Mandatory parameters are left unspecified; 593 * 2.Incorrect parameter types. 594 * @syscap SystemCapability.Utils.Lang 595 * @crossplatform 596 * @atomicservice 597 * @since 12 598 */ 599 removeAt(index: number): boolean; 600 /** 601 * Removes all of the mapping from this map 602 * The map will be empty after this call returns 603 * 604 * @throws { BusinessError } 10200011 - The clear method cannot be bound. 605 * @syscap SystemCapability.Utils.Lang 606 * @since 8 607 */ 608 /** 609 * Removes all of the mapping from this map 610 * The map will be empty after this call returns 611 * 612 * @throws { BusinessError } 10200011 - The clear method cannot be bound. 613 * @syscap SystemCapability.Utils.Lang 614 * @crossplatform 615 * @since 10 616 */ 617 /** 618 * Removes all of the mapping from this map 619 * The map will be empty after this call returns 620 * 621 * @throws { BusinessError } 10200011 - The clear method cannot be bound. 622 * @syscap SystemCapability.Utils.Lang 623 * @crossplatform 624 * @atomicservice 625 * @since 12 626 */ 627 clear(): void; 628 /** 629 * Sets the value identified by index in an LightWeightMap container to a specified value 630 * 631 * @param { number } index - index index Target subscript for search 632 * @param { V } newValue - newValue value Updated the target mapped value 633 * @returns { boolean } the boolean type(Is there a value corresponding to the subscript) 634 * @throws { BusinessError } 10200011 - The setValueAt method cannot be bound. 635 * @throws { BusinessError } 10200001 - The value of index is out of range. 636 * @throws { BusinessError } 401 - Parameter error. Possible causes: 637 * 1.Mandatory parameters are left unspecified; 638 * 2.Incorrect parameter types; 639 * 3.Parameter verification failed. 640 * @syscap SystemCapability.Utils.Lang 641 * @since 8 642 */ 643 /** 644 * Sets the value identified by index in an LightWeightMap container to a specified value 645 * 646 * @param { number } index - index index Target subscript for search 647 * @param { V } newValue - newValue value Updated the target mapped value 648 * @returns { boolean } the boolean type(Is there a value corresponding to the subscript) 649 * @throws { BusinessError } 10200011 - The setValueAt method cannot be bound. 650 * @throws { BusinessError } 10200001 - The value of index is out of range. 651 * @throws { BusinessError } 401 - Parameter error. Possible causes: 652 * 1.Mandatory parameters are left unspecified; 653 * 2.Incorrect parameter types; 654 * 3.Parameter verification failed. 655 * @syscap SystemCapability.Utils.Lang 656 * @crossplatform 657 * @since 10 658 */ 659 /** 660 * Sets the value identified by index in an LightWeightMap container to a specified value 661 * 662 * @param { number } index - index index Target subscript for search 663 * @param { V } newValue - newValue value Updated the target mapped value 664 * @returns { boolean } the boolean type(Is there a value corresponding to the subscript) 665 * @throws { BusinessError } 10200011 - The setValueAt method cannot be bound. 666 * @throws { BusinessError } 10200001 - The value of index is out of range. 667 * @throws { BusinessError } 401 - Parameter error. Possible causes: 668 * 1.Mandatory parameters are left unspecified; 669 * 2.Incorrect parameter types; 670 * 3.Parameter verification failed. 671 * @syscap SystemCapability.Utils.Lang 672 * @crossplatform 673 * @atomicservice 674 * @since 12 675 */ 676 setValueAt(index: number, newValue: V): boolean; 677 /** 678 * Executes the given callback function once for each real key in the map. 679 * It does not perform functions on deleted keys. 680 * 681 * @param { function } callbackFn - callbackFn 682 * callbackFn (required) A function that accepts up to three arguments. 683 * The function to be called for each element. 684 * @param { Object } [thisArg] - thisArg 685 * thisArg (Optional) The value to be used as this value for when callbackFn is called. 686 * If thisArg is omitted, undefined is used as the this value. 687 * @throws { BusinessError } 10200011 - The forEach method cannot be bound. 688 * @throws { BusinessError } 401 - Parameter error. Possible causes: 689 * 1.Mandatory parameters are left unspecified; 690 * 2.Incorrect parameter types. 691 * @syscap SystemCapability.Utils.Lang 692 * @since 8 693 */ 694 /** 695 * Executes the given callback function once for each real key in the map. 696 * It does not perform functions on deleted keys. 697 * 698 * @param { function } callbackFn - callbackFn 699 * callbackFn (required) A function that accepts up to three arguments. 700 * The function to be called for each element. 701 * @param { Object } [thisArg] - thisArg 702 * thisArg (Optional) The value to be used as this value for when callbackFn is called. 703 * If thisArg is omitted, undefined is used as the this value. 704 * @throws { BusinessError } 10200011 - The forEach method cannot be bound. 705 * @throws { BusinessError } 401 - Parameter error. Possible causes: 706 * 1.Mandatory parameters are left unspecified; 707 * 2.Incorrect parameter types. 708 * @syscap SystemCapability.Utils.Lang 709 * @crossplatform 710 * @since 10 711 */ 712 /** 713 * Executes the given callback function once for each real key in the map. 714 * It does not perform functions on deleted keys. 715 * 716 * @param { function } callbackFn - callbackFn 717 * callbackFn (required) A function that accepts up to three arguments. 718 * The function to be called for each element. 719 * @param { Object } [thisArg] - thisArg 720 * thisArg (Optional) The value to be used as this value for when callbackFn is called. 721 * If thisArg is omitted, undefined is used as the this value. 722 * @throws { BusinessError } 10200011 - The forEach method cannot be bound. 723 * @throws { BusinessError } 401 - Parameter error. Possible causes: 724 * 1.Mandatory parameters are left unspecified; 725 * 2.Incorrect parameter types. 726 * @syscap SystemCapability.Utils.Lang 727 * @crossplatform 728 * @atomicservice 729 * @since 12 730 */ 731 forEach(callbackFn: (value?: V, key?: K, map?: LightWeightMap<K, V>) => void, thisArg?: Object): void; 732 /** 733 * returns an ES6 iterator.Each item of the iterator is a Javascript Object 734 * 735 * @returns { IterableIterator<[K, V]> } 736 * @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound. 737 * @syscap SystemCapability.Utils.Lang 738 * @since 8 739 */ 740 /** 741 * returns an ES6 iterator.Each item of the iterator is a Javascript Object 742 * 743 * @returns { IterableIterator<[K, V]> } 744 * @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound. 745 * @syscap SystemCapability.Utils.Lang 746 * @crossplatform 747 * @since 10 748 */ 749 /** 750 * returns an ES6 iterator.Each item of the iterator is a Javascript Object 751 * 752 * @returns { IterableIterator<[K, V]> } 753 * @throws { BusinessError } 10200011 - The Symbol.iterator method cannot be bound. 754 * @syscap SystemCapability.Utils.Lang 755 * @crossplatform 756 * @atomicservice 757 * @since 12 758 */ 759 [Symbol.iterator](): IterableIterator<[K, V]>; 760 /** 761 * Obtains a string that contains all the keys and values in an LightWeightMap container 762 * 763 * @returns { String } 764 * @throws { BusinessError } 10200011 - The toString method cannot be bound. 765 * @syscap SystemCapability.Utils.Lang 766 * @since 8 767 */ 768 /** 769 * Obtains a string that contains all the keys and values in an LightWeightMap container 770 * 771 * @returns { String } 772 * @throws { BusinessError } 10200011 - The toString method cannot be bound. 773 * @syscap SystemCapability.Utils.Lang 774 * @crossplatform 775 * @since 10 776 */ 777 /** 778 * Obtains a string that contains all the keys and values in an LightWeightMap container 779 * 780 * @returns { String } 781 * @throws { BusinessError } 10200011 - The toString method cannot be bound. 782 * @syscap SystemCapability.Utils.Lang 783 * @crossplatform 784 * @atomicservice 785 * @since 12 786 */ 787 toString(): String; 788 /** 789 * Obtains the value identified by index in an LightWeightMap container 790 * 791 * @param { number } index - index index Target subscript for search 792 * @returns { V } the value of key-value pairs 793 * @throws { BusinessError } 10200011 - The getValueAt method cannot be bound. 794 * @throws { BusinessError } 10200001 - The value of index is out of range. 795 * @throws { BusinessError } 401 - Parameter error. Possible causes: 796 * 1.Mandatory parameters are left unspecified; 797 * 2.Incorrect parameter types; 798 * 3.Parameter verification failed. 799 * @syscap SystemCapability.Utils.Lang 800 * @since 8 801 */ 802 /** 803 * Obtains the value identified by index in an LightWeightMap container 804 * 805 * @param { number } index - index index Target subscript for search 806 * @returns { V } the value of key-value pairs 807 * @throws { BusinessError } 10200011 - The getValueAt method cannot be bound. 808 * @throws { BusinessError } 10200001 - The value of index is out of range. 809 * @throws { BusinessError } 401 - Parameter error. Possible causes: 810 * 1.Mandatory parameters are left unspecified; 811 * 2.Incorrect parameter types; 812 * 3.Parameter verification failed. 813 * @syscap SystemCapability.Utils.Lang 814 * @crossplatform 815 * @since 10 816 */ 817 /** 818 * Obtains the value identified by index in an LightWeightMap container 819 * 820 * @param { number } index - index index Target subscript for search 821 * @returns { V } the value of key-value pairs 822 * @throws { BusinessError } 10200011 - The getValueAt method cannot be bound. 823 * @throws { BusinessError } 10200001 - The value of index is out of range. 824 * @throws { BusinessError } 401 - Parameter error. Possible causes: 825 * 1.Mandatory parameters are left unspecified; 826 * 2.Incorrect parameter types; 827 * 3.Parameter verification failed. 828 * @syscap SystemCapability.Utils.Lang 829 * @crossplatform 830 * @atomicservice 831 * @since 12 832 */ 833 getValueAt(index: number): V; 834 /** 835 * Returns an iterator of the values contained in this map 836 * 837 * @returns { IterableIterator<V> } 838 * @throws { BusinessError } 10200011 - The values method cannot be bound. 839 * @syscap SystemCapability.Utils.Lang 840 * @since 8 841 */ 842 /** 843 * Returns an iterator of the values contained in this map 844 * 845 * @returns { IterableIterator<V> } 846 * @throws { BusinessError } 10200011 - The values method cannot be bound. 847 * @syscap SystemCapability.Utils.Lang 848 * @crossplatform 849 * @since 10 850 */ 851 /** 852 * Returns an iterator of the values contained in this map 853 * 854 * @returns { IterableIterator<V> } 855 * @throws { BusinessError } 10200011 - The values method cannot be bound. 856 * @syscap SystemCapability.Utils.Lang 857 * @crossplatform 858 * @atomicservice 859 * @since 12 860 */ 861 values(): IterableIterator<V>; 862} 863 864export default LightWeightMap; 865