2020-06-04 14:56:45 +00:00
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home ](./index.md ) > [puppeteer ](./puppeteer.md ) > [Accessibility ](./puppeteer.accessibility.md ) > [snapshot ](./puppeteer.accessibility.snapshot.md )
## Accessibility.snapshot() method
2020-06-05 14:20:11 +00:00
Captures the current state of the accessibility tree. The returned object represents the root accessible node of the page.
2020-06-04 14:56:45 +00:00
< b > Signature:< / b >
```typescript
2020-06-05 14:20:11 +00:00
snapshot(options?: SnapshotOptions): Promise< SerializedAXNode > ;
2020-06-04 14:56:45 +00:00
```
## Parameters
| Parameter | Type | Description |
| --- | --- | --- |
2020-06-05 14:20:11 +00:00
| options | [SnapshotOptions ](./puppeteer.snapshotoptions.md ) | |
2020-06-04 14:56:45 +00:00
< b > Returns:< / b >
2020-06-05 14:20:11 +00:00
Promise< [SerializedAXNode](./puppeteer.serializedaxnode.md)<!-- --> >
2020-06-19 13:30:28 +00:00
An AXNode object representing the snapshot.
2020-06-05 14:20:11 +00:00
## Remarks
\*\*NOTE\*\* The Chromium accessibility tree contains nodes that go unused on most platforms and by most screen readers. Puppeteer will discard them as well for an easier to process tree, unless `interestingOnly` is set to `false` <!-- --> .
## Example 1
An example of dumping the entire accessibility tree:
```js
const snapshot = await page.accessibility.snapshot();
console.log(snapshot);
```
## Example 2
An example of logging the focused node's name:
```js
const snapshot = await page.accessibility.snapshot();
const node = findFocusedNode(snapshot);
console.log(node & & node.name);
function findFocusedNode(node) {
if (node.focused)
return node;
for (const child of node.children || []) {
const foundNode = findFocusedNode(child);
return foundNode;
}
return null;
}
```
2020-06-04 14:56:45 +00:00