js-apis-stack.md 4.3 KB
Newer Older
L
linhaoran 已提交
1 2 3 4 5 6 7 8 9
# 线性容器Stack

> ![icon-note.gif](public_sys-resources/icon-note.gif) **说明:**
> 本模块首批接口从API version 8开始支持。后续版本的新增接口,采用上角标单独标记接口的起始版本。


## 导入模块

```
10
import Stack from '@ohos.util.Stack'  
L
linhaoran 已提交
11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222
```


## 权限




## Stack


### 属性

| 名称 | 参数类型 | 可读 | 可写 | 说明 |
| -------- | -------- | -------- | -------- | -------- |
| length | number | 是 | 否 | Stack的元素个数 |


### constructor

constructor();

Stack的构造函数。


- 示例:
  ```
  let stack = new Stack();
  ```


### push

push(item: T): T;

在栈顶插入元素,并返回该元素。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | item | T | 是 | 添加进去的元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回被添加进去的元素 |

- 示例:
  ```
  let stack = new Stack();
  stack.push("a");
  stack.push(1);
  let b = [1, 2, 3];
  stack.push(b);
  let c = {name : "lala", age : "13"};
  stack.push(false);
  ```

### pop

pop(): T;

删除栈顶元素并返回该删除元素。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回删除的元素 |

- 示例:
  ```
  let stack = new Stack();
  stack.push(2);
  stack.push(4);
  stack.push(5);
  stack.push(2);
  stack.push(4);
  stack.pop();
  ```

### peek

peek(): T;

获取并返回栈顶元素。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | T | 返回栈顶元素 |

- 示例:
  ```
  let stack = new Stack();
  stack.push(2);
  stack.push(4);
  stack.push(5);
  stack.push(2);
  stack.peek();
  ```
### locate

locate(element: T): number;

返回指定元素第一次出现时的下标值,查找失败返回-1。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | element | T | 是 | 指定元素 |

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | number | 找到就返回下标值,查找失败返回-1 |
- 示例:
  ```
  let stack = new Stack();
  stack.push(2);
  stack.push(4);
  stack.push(5);
  stack.push(2);
  stack.locate(2);
  ```

### forEach
forEach(callbackfn: (value: T, index?: number, stack?: Stack<T>) => void,
thisArg?: Object): void;

通过回调函数来遍历Stack实例对象上的元素以及元素对应的下标。

- 参数:
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | callbackfn | function | 是 | 回调函数 |
  | thisArg | Object | 否 | callbackfn被调用时用作this值 |

- callbackfn的参数说明
  
  | 参数名 | 类型 | 必填 | 说明 |
  | -------- | -------- | -------- | -------- |
  | value | T | 是 | 当前遍历到的元素。 |
  | index | number | 否 | 当前遍历到的下标值。 |
  | stack | Stack<T> | 否 | 当前调用forEach方法的实例对象。 |


- 示例:
  ```
  let stack = new Stack();
  stack.push(2);
  stack.push(4);
  stack.push(5);
  stack.push(4);
  stack.forEach((value, index) => {
   console.log(value, index);
  });
  ```
### isEmpty
isEmpty(): boolean;

判断该栈是否为空。

- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | boolean | 为空返回true, 不为空返回false |

- 示例:
  ```
  let stack = new Stack();
  stack.push(2);
  stack.push(4);
  stack.push(5);
  stack.push(4);
  stack.isEmpty();
  ```

### [Symbol.iterator]

[Symbol.iterator]\(): IterableIterator<T>;


返回一个迭代器,迭代器的每一项都是一个 JavaScript 对象,并返回该对象。


- 返回值:
  | 类型 | 说明 |
  | -------- | -------- |
  | IterableIterator<T> | 返回一个迭代器 |


- 示例:
  ```
  let stack = new Stack();
  stack.push(2);
  stack.push(4);
  stack.push(5);
  stack.push(4);

  // 使用方法一:
  for (let item of stack) { 
    console.log(item); 
  }

  // 使用方法二:
  let iter = stack[Symbol.iterator]();
  let temp = iter.next().value;
  while(temp != undefined) {
    console.log(temp);
    temp = iter.next().value;
  }
  ```