@sebbo2002/node-pyatv 4.3.4-develop.4 → 5.1.0-develop.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (94) hide show
  1. package/.mocharc.yml +3 -3
  2. package/.nycrc +1 -0
  3. package/CHANGELOG.md +31 -0
  4. package/dist/bin/check.js +2 -6
  5. package/dist/bin/check.js.map +1 -1
  6. package/dist/examples/push.js +2 -6
  7. package/dist/examples/push.js.map +1 -1
  8. package/dist/lib/device-event.d.ts +2 -2
  9. package/dist/lib/device-event.js +1 -3
  10. package/dist/lib/device-event.js.map +1 -1
  11. package/dist/lib/device-events.d.ts +2 -2
  12. package/dist/lib/device-events.js +38 -40
  13. package/dist/lib/device-events.js.map +1 -1
  14. package/dist/lib/device.d.ts +47 -2
  15. package/dist/lib/device.js +99 -46
  16. package/dist/lib/device.js.map +1 -1
  17. package/dist/lib/fake-spawn.js +7 -14
  18. package/dist/lib/fake-spawn.js.map +1 -1
  19. package/dist/lib/index.d.ts +6 -5
  20. package/dist/lib/index.js +6 -22
  21. package/dist/lib/index.js.map +1 -1
  22. package/dist/lib/instance.d.ts +2 -2
  23. package/dist/lib/instance.js +40 -32
  24. package/dist/lib/instance.js.map +1 -1
  25. package/dist/lib/tools.d.ts +1 -1
  26. package/dist/lib/tools.js +24 -34
  27. package/dist/lib/tools.js.map +1 -1
  28. package/dist/lib/types.d.ts +24 -0
  29. package/dist/lib/types.js +20 -23
  30. package/dist/lib/types.js.map +1 -1
  31. package/docs/coverage/block-navigation.js +8 -0
  32. package/docs/coverage/cobertura-coverage.xml +2818 -1534
  33. package/docs/coverage/device-event.ts.html +64 -59
  34. package/docs/coverage/device-events.ts.html +215 -210
  35. package/docs/coverage/device.ts.html +931 -740
  36. package/docs/coverage/fake-spawn.ts.html +102 -97
  37. package/docs/coverage/favicon.png +0 -0
  38. package/docs/coverage/index.html +74 -69
  39. package/docs/coverage/index.ts.html +63 -49
  40. package/docs/coverage/instance.ts.html +256 -224
  41. package/docs/coverage/sort-arrow-sprite.png +0 -0
  42. package/docs/coverage/sorter.js +26 -0
  43. package/docs/coverage/tools.ts.html +310 -305
  44. package/docs/coverage/types.ts.html +204 -121
  45. package/docs/reference/assets/highlight.css +11 -25
  46. package/docs/reference/assets/main.js +4 -2
  47. package/docs/reference/assets/search.js +1 -1
  48. package/docs/reference/assets/style.css +424 -538
  49. package/docs/reference/classes/NodePyATVDevice.html +1136 -126
  50. package/docs/reference/classes/NodePyATVDeviceEvent.html +111 -10
  51. package/docs/reference/classes/NodePyATVInstance.html +227 -0
  52. package/docs/reference/enums/NodePyATVDeviceState.html +93 -1
  53. package/docs/reference/enums/NodePyATVExecutableType.html +65 -0
  54. package/docs/reference/enums/NodePyATVKeys.html +212 -1
  55. package/docs/reference/enums/NodePyATVListenerState.html +79 -1
  56. package/docs/reference/enums/NodePyATVMediaType.html +79 -1
  57. package/docs/reference/enums/NodePyATVPowerState.html +65 -1
  58. package/docs/reference/enums/NodePyATVProtocol.html +79 -1
  59. package/docs/reference/enums/NodePyATVRepeatState.html +72 -1
  60. package/docs/reference/enums/NodePyATVShuffleState.html +72 -1
  61. package/docs/reference/index.html +61 -53
  62. package/docs/reference/interfaces/NodePyATVDeviceOptions.html +229 -1
  63. package/docs/reference/interfaces/NodePyATVFindAndInstanceOptions.html +190 -1
  64. package/docs/reference/interfaces/NodePyATVFindOptions.html +120 -1
  65. package/docs/reference/interfaces/NodePyATVGetStateOptions.html +62 -1
  66. package/docs/reference/interfaces/NodePyATVInstanceOptions.html +110 -1
  67. package/docs/reference/interfaces/NodePyATVService.html +69 -0
  68. package/docs/reference/interfaces/NodePyATVState.html +160 -1
  69. package/docs/reference/interfaces/NodePyATVVersionResponse.html +69 -1
  70. package/docs/reference/modules.html +104 -1
  71. package/docs/reference/types/NodePyATVEventValueType.html +64 -0
  72. package/docs/tests/index.html +1 -1
  73. package/docs/tests/mochawesome.json +1074 -784
  74. package/package.json +18 -15
  75. package/release.config.cjs +56 -0
  76. package/src/bin/check.ts +1 -1
  77. package/src/examples/push.ts +1 -1
  78. package/src/lib/device-event.ts +2 -2
  79. package/src/lib/device-events.ts +4 -4
  80. package/src/lib/device.ts +65 -3
  81. package/src/lib/index.ts +20 -17
  82. package/src/lib/instance.ts +31 -22
  83. package/src/lib/tools.ts +1 -1
  84. package/src/lib/types.ts +26 -0
  85. package/test/device-event.ts +2 -2
  86. package/test/device-events.ts +2 -2
  87. package/test/device.ts +127 -4
  88. package/test/instance.ts +128 -42
  89. package/test/tools.ts +2 -2
  90. package/tsconfig.json +1 -1
  91. package/docs/reference/assets/icons.css +0 -1043
  92. package/docs/reference/assets/icons.png +0 -0
  93. package/docs/reference/assets/icons@2x.png +0 -0
  94. package/docs/reference/classes/default.html +0 -50
package/docs/reference/assets/icons.png DELETED
Binary file
package/docs/reference/assets/icons@2x.png DELETED
Binary file
package/docs/reference/classes/default.html DELETED
@@ -1,50 +0,0 @@
1
- <!DOCTYPE html><html class="default"><head><meta charSet="utf-8"/><meta http-equiv="x-ua-compatible" content="IE=edge"/><title>default | node-pyatv - v4.3.4-develop.4</title><meta name="description" content="Documentation for node-pyatv - v4.3.4-develop.4"/><meta name="viewport" content="width=device-width, initial-scale=1"/><link rel="stylesheet" href="../assets/style.css"/><link rel="stylesheet" href="../assets/highlight.css"/><script async src="../assets/search.js" id="search-script"></script></head><body><script>document.body.classList.add(localStorage.getItem("tsd-theme") || "os")</script><header><div class="tsd-page-toolbar"><div class="container"><div class="table-wrap"><div class="table-cell" id="tsd-search" data-base=".."><div class="field"><label for="tsd-search-field" class="tsd-widget search no-caption">Search</label><input type="text" id="tsd-search-field"/></div><ul class="results"><li class="state loading">Preparing search index...</li><li class="state failure">The search index is not available</li></ul><a href="../index.html" class="title">node-pyatv - v4.3.4-develop.4</a></div><div class="table-cell" id="tsd-widgets"><div id="tsd-filter"><a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a><div class="tsd-filter-group"><div class="tsd-select" id="tsd-filter-visibility"><span class="tsd-select-label">All</span><ul class="tsd-select-list"><li data-value="public">Public</li><li data-value="protected">Public/Protected</li><li data-value="private" class="selected">All</li></ul></div> <input type="checkbox" id="tsd-filter-inherited" checked/><label class="tsd-widget" for="tsd-filter-inherited">Inherited</label><input type="checkbox" id="tsd-filter-externals" checked/><label class="tsd-widget" for="tsd-filter-externals">Externals</label></div></div><a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a></div></div></div></div><div class="tsd-page-title"><div class="container"><ul class="tsd-breadcrumb"><li><a href="../modules.html">node-pyatv - v4.3.4-develop.4</a></li><li><a href="default.html">default</a></li></ul><h1>Class default </h1></div></div></header><div class="container container-main"><div class="row"><div class="col-8 col-content"><section class="tsd-panel tsd-comment"><div class="tsd-comment tsd-typography"><div class="lead">
2
- <p>Default class exported by <code>@sebbo2002/node-pyatv</code>. Use <a href="default.html#find">find</a> to scan for devices in your local network. Use
3
- <a href="default.html#device">device</a> to connect to a known device by passing (at least) it&#39;s name and IP.</p>
4
- </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@sebbo2002/node-pyatv&#39;</span><span class="hl-1">;</span>
5
- </code></pre>
6
- </div></div></section><section class="tsd-panel tsd-hierarchy"><h3>Hierarchy</h3><ul class="tsd-hierarchy"><li><span class="target">default</span></li></ul></section><section class="tsd-panel-group tsd-index-group"><h2>Index</h2><section class="tsd-panel tsd-index-panel"><div class="tsd-index-content"><section class="tsd-index-section "><h3>Constructors</h3><ul class="tsd-index-list"><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="default.html#constructor" class="tsd-kind-icon">constructor</a></li></ul></section><section class="tsd-index-section "><h3>Methods</h3><ul class="tsd-index-list"><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#check" class="tsd-kind-icon">check</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#device" class="tsd-kind-icon">device</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#find" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#check-1" class="tsd-kind-icon">check</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#device-1" class="tsd-kind-icon">device</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#find-1" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#version-1" class="tsd-kind-icon">version</a></li></ul></section></div></section></section><section class="tsd-panel-group tsd-member-group "><h2>Constructors</h2><section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class"><a id="constructor" class="tsd-anchor"></a><h3 class="tsd-anchor-link">constructor<a href="#constructor" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">new default<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L151">src/lib/instance.ts:151</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
7
- <p>Use this to apply <a href="../interfaces/NodePyATVInstanceOptions.html">NodePyATVInstanceOptions</a>
8
- (e.g. debug log method) to all further requests</p>
9
- </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@sebbo2002/node-pyatv&#39;</span><span class="hl-1">;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">myPyatv</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">pyatv</span><span class="hl-1">({</span><span class="hl-0">debug:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">});</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">devices</span><span class="hl-1"> = </span><span class="hl-0">myPyatv</span><span class="hl-1">.</span><span class="hl-6">find</span><span class="hl-1">();</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">devices</span><span class="hl-1">);</span>
10
- </code></pre>
11
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
12
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="default.html" class="tsd-signature-type" data-tsd-kind="Class">default</a></h4></li></ul></section></section><section class="tsd-panel-group tsd-member-group "><h2>Methods</h2><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="check" class="tsd-anchor"></a><h3 class="tsd-anchor-link">check<a href="#check" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L161">src/lib/instance.ts:161</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
13
- <p>Checks if pyatv is installed and ready to be used.
14
- Will throw an error if not.</p>
15
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
16
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="device" class="tsd-anchor"></a><h3 class="tsd-anchor-link">device<a href="#device" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">device<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L199">src/lib/instance.ts:199</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
17
- <p>Create a <a href="NodePyATVDevice.html">NodePyATVDevice</a> to query the state and control it.
18
- At least <code>host</code> and <code>name</code> are required.</p>
19
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
20
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="find" class="tsd-anchor"></a><h3 class="tsd-anchor-link">find<a href="#find" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L189">src/lib/instance.ts:189</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
21
- <p>Scan the network for Apple TVs by using pyatv&#39;s atvscript. See <a href="../interfaces/NodePyATVFindAndInstanceOptions.html">NodePyATVFindAndInstanceOptions</a>
22
- for the options allowed. Use the <code>host</code> / <code>hosts</code> attribute to filter by IP addresses. Resolves with
23
- an array of <a href="NodePyATVDevice.html">NodePyATVDevice</a>.</p>
24
- </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@sebbo2002/node-pyatv&#39;</span><span class="hl-1">;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">myPyATV</span><span class="hl-1"> = </span><span class="hl-4">new</span><span class="hl-1"> </span><span class="hl-6">pyatv</span><span class="hl-1">({</span><span class="hl-0">debug:</span><span class="hl-1"> </span><span class="hl-4">true</span><span class="hl-1">});</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">devices</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">myPyATV</span><span class="hl-1">.</span><span class="hl-6">find</span><span class="hl-1">();</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">devices</span><span class="hl-1">);</span>
25
- </code></pre>
26
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
27
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class"><a id="version" class="tsd-anchor"></a><h3 class="tsd-anchor-link">version<a href="#version" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"><li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L171">src/lib/instance.ts:171</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
28
- <p>Resolves with the version of pyatv and of the module itself.
29
- If a value can&#39;t be found, null is returned instead.</p>
30
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
31
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="check-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> check<a href="#check-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">check<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L33">src/lib/instance.ts:33</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
32
- <p>Checks if pyatv is installed and ready to be used.
33
- Will throw an error if not.</p>
34
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
35
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><span class="tsd-signature-type">void</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="device-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> device<a href="#device-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">device<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">: </span><a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L135">src/lib/instance.ts:135</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
36
- <p>Create a <a href="NodePyATVDevice.html">NodePyATVDevice</a> to query the state and control it.
37
- At least <code>host</code> and <code>name</code> are required.</p>
38
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVDeviceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVDeviceOptions</a></h5><div class="tsd-comment tsd-typography"><div class="lead">
39
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="find-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> find<a href="#find-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">find<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L108">src/lib/instance.ts:108</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
40
- <p>Scan the network for Apple TVs by using pyatv&#39;s atvscript. See <a href="../interfaces/NodePyATVFindAndInstanceOptions.html">NodePyATVFindAndInstanceOptions</a>
41
- for the options allowed. Use the <code>host</code> / <code>hosts</code> attribute to filter by IP addresses. Resolves with
42
- an array of <a href="NodePyATVDevice.html">NodePyATVDevice</a>.</p>
43
- </div><div><pre><code class="language-typescript"><span class="hl-2">import</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1"> </span><span class="hl-2">from</span><span class="hl-1"> </span><span class="hl-3">&#39;@sebbo2002/node-pyatv&#39;</span><span class="hl-1">;</span><br/><span class="hl-4">const</span><span class="hl-1"> </span><span class="hl-5">devices</span><span class="hl-1"> = </span><span class="hl-2">await</span><span class="hl-1"> </span><span class="hl-0">pyatv</span><span class="hl-1">.</span><span class="hl-6">find</span><span class="hl-1">();</span><br/><span class="hl-0">console</span><span class="hl-1">.</span><span class="hl-6">log</span><span class="hl-1">(</span><span class="hl-0">devices</span><span class="hl-1">);</span>
44
- </code></pre>
45
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVFindAndInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVFindAndInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
46
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="NodePyATVDevice.html" class="tsd-signature-type" data-tsd-kind="Class">NodePyATVDevice</a><span class="tsd-signature-symbol">[]</span><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section><section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-static"><a id="version-1" class="tsd-anchor"></a><h3 class="tsd-anchor-link"><span class="tsd-flag ts-flagStatic">Static</span> version<a href="#version-1" aria-label="Permalink" class="tsd-anchor-icon"><svg xmlns="http://www.w3.org/2000/svg" class="icon icon-tabler icon-tabler-link" viewBox="0 0 24 24" stroke-width="2" stroke="currentColor" fill="none" stroke-linecap="round" stroke-linejoin="round"><path stroke="none" d="M0 0h24v24H0z" fill="none"></path><path d="M10 14a3.5 3.5 0 0 0 5 0l4 -4a3.5 3.5 0 0 0 -5 -5l-.5 .5"></path><path d="M14 10a3.5 3.5 0 0 0 -5 0l-4 4a3.5 3.5 0 0 0 5 5l.5 -.5"></path></svg></a></h3><ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-static"><li class="tsd-signature tsd-kind-icon">version<span class="tsd-signature-symbol">(</span>options<span class="tsd-signature-symbol">?: </span><a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">&gt;</span></li></ul><ul class="tsd-descriptions"><li class="tsd-description"><aside class="tsd-sources"><ul><li>Defined in <a href="https://github.com/sebbo2002/node-pyatv/blob/37fdeb0/src/lib/instance.ts#L56">src/lib/instance.ts:56</a></li></ul></aside><div class="tsd-comment tsd-typography"><div class="lead">
47
- <p>Resolves with the version of pyatv and of the module itself.
48
- If a value can&#39;t be found, null is returned instead.</p>
49
- </div></div><h4 class="tsd-parameters-title">Parameters</h4><ul class="tsd-parameters"><li><h5>options: <a href="../interfaces/NodePyATVInstanceOptions.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVInstanceOptions</a><span class="tsd-signature-symbol"> = {}</span></h5><div class="tsd-comment tsd-typography"><div class="lead">
50
- </div></div></li></ul><h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol">&lt;</span><a href="../interfaces/NodePyATVVersionResponse.html" class="tsd-signature-type" data-tsd-kind="Interface">NodePyATVVersionResponse</a><span class="tsd-signature-symbol">&gt;</span></h4></li></ul></section></section></div><div class="col-4 col-menu menu-sticky-wrap menu-highlight"><nav class="tsd-navigation primary"><ul><li class=""><a href="../modules.html">Exports</a></li></ul></nav><nav class="tsd-navigation secondary menu-sticky"><ul><li class="current tsd-kind-class"><a href="default.html" class="tsd-kind-icon">default</a><ul><li class="tsd-kind-constructor tsd-parent-kind-class"><a href="default.html#constructor" class="tsd-kind-icon">constructor</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#check" class="tsd-kind-icon">check</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#device" class="tsd-kind-icon">device</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#find" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class"><a href="default.html#version" class="tsd-kind-icon">version</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#check-1" class="tsd-kind-icon">check</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#device-1" class="tsd-kind-icon">device</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#find-1" class="tsd-kind-icon">find</a></li><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><a href="default.html#version-1" class="tsd-kind-icon">version</a></li></ul></li></ul></nav></div></div></div><footer class="with-border-bottom"><div class="container"><h2>Legend</h2><div class="tsd-legend-group"><ul class="tsd-legend"><li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li><li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li><li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li><li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li></ul><ul class="tsd-legend"><li class="tsd-kind-method tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li></ul></div><h2>Settings</h2><p>Theme <select id="theme"><option value="os">OS</option><option value="light">Light</option><option value="dark">Dark</option></select></p></div></footer><div class="container tsd-generator"><p>Generated using <a href="https://typedoc.org/" target="_blank">TypeDoc</a></p></div><div class="overlay"></div><script src="../assets/main.js"></script></body></html>