diff --git a/docs/.nojekyll b/docs/.nojekyll deleted file mode 100644 index e2ac661..0000000 --- a/docs/.nojekyll +++ /dev/null @@ -1 +0,0 @@ -TypeDoc added this file to prevent GitHub Pages from using Jekyll. You can turn off this behavior by setting the `githubPages` option to false. \ No newline at end of file diff --git a/docs/assets/highlight.css b/docs/assets/highlight.css deleted file mode 100644 index 086d4b2..0000000 --- a/docs/assets/highlight.css +++ /dev/null @@ -1,120 +0,0 @@ -:root { - --light-hl-0: #000000; - --dark-hl-0: #D4D4D4; - --light-hl-1: #AF00DB; - --dark-hl-1: #C586C0; - --light-hl-2: #0000FF; - --dark-hl-2: #569CD6; - --light-hl-3: #001080; - --dark-hl-3: #9CDCFE; - --light-hl-4: #A31515; - --dark-hl-4: #CE9178; - --light-hl-5: #008000; - --dark-hl-5: #6A9955; - --light-hl-6: #0070C1; - --dark-hl-6: #4FC1FF; - --light-hl-7: #795E26; - --dark-hl-7: #DCDCAA; - --light-hl-8: #098658; - --dark-hl-8: #B5CEA8; - --light-hl-9: #267F99; - --dark-hl-9: #4EC9B0; - --light-hl-10: #000000FF; - --dark-hl-10: #D4D4D4; - --light-hl-11: #811F3F; - --dark-hl-11: #D16969; - --light-hl-12: #EE0000; - --dark-hl-12: #D7BA7D; - --light-hl-13: #000000; - --dark-hl-13: #C8C8C8; - --light-code-background: #FFFFFF; - --dark-code-background: #1E1E1E; -} - -@media (prefers-color-scheme: light) { :root { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --code-background: var(--light-code-background); -} } - -@media (prefers-color-scheme: dark) { :root { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --code-background: var(--dark-code-background); -} } - -body.light { - --hl-0: var(--light-hl-0); - --hl-1: var(--light-hl-1); - --hl-2: var(--light-hl-2); - --hl-3: var(--light-hl-3); - --hl-4: var(--light-hl-4); - --hl-5: var(--light-hl-5); - --hl-6: var(--light-hl-6); - --hl-7: var(--light-hl-7); - --hl-8: var(--light-hl-8); - --hl-9: var(--light-hl-9); - --hl-10: var(--light-hl-10); - --hl-11: var(--light-hl-11); - --hl-12: var(--light-hl-12); - --hl-13: var(--light-hl-13); - --code-background: var(--light-code-background); -} - -body.dark { - --hl-0: var(--dark-hl-0); - --hl-1: var(--dark-hl-1); - --hl-2: var(--dark-hl-2); - --hl-3: var(--dark-hl-3); - --hl-4: var(--dark-hl-4); - --hl-5: var(--dark-hl-5); - --hl-6: var(--dark-hl-6); - --hl-7: var(--dark-hl-7); - --hl-8: var(--dark-hl-8); - --hl-9: var(--dark-hl-9); - --hl-10: var(--dark-hl-10); - --hl-11: var(--dark-hl-11); - --hl-12: var(--dark-hl-12); - --hl-13: var(--dark-hl-13); - --code-background: var(--dark-code-background); -} - -.hl-0 { color: var(--hl-0); } -.hl-1 { color: var(--hl-1); } -.hl-2 { color: var(--hl-2); } -.hl-3 { color: var(--hl-3); } -.hl-4 { color: var(--hl-4); } -.hl-5 { color: var(--hl-5); } -.hl-6 { color: var(--hl-6); } -.hl-7 { color: var(--hl-7); } -.hl-8 { color: var(--hl-8); } -.hl-9 { color: var(--hl-9); } -.hl-10 { color: var(--hl-10); } -.hl-11 { color: var(--hl-11); } -.hl-12 { color: var(--hl-12); } -.hl-13 { color: var(--hl-13); } -pre, code { background: var(--code-background); } diff --git a/docs/assets/icons.css b/docs/assets/icons.css deleted file mode 100644 index 776a356..0000000 --- a/docs/assets/icons.css +++ /dev/null @@ -1,1043 +0,0 @@ -.tsd-kind-icon { - display: block; - position: relative; - padding-left: 20px; - text-indent: -20px; -} -.tsd-kind-icon:before { - content: ""; - display: inline-block; - vertical-align: middle; - width: 17px; - height: 17px; - margin: 0 3px 2px 0; - background-image: url(./icons.png); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-kind-icon:before { - background-image: url(./icons@2x.png); - background-size: 238px 204px; - } -} - -.tsd-signature.tsd-kind-icon:before { - background-position: 0 -153px; -} - -.tsd-kind-object-literal > .tsd-kind-icon:before { - background-position: 0px -17px; -} -.tsd-kind-object-literal.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -17px; -} -.tsd-kind-object-literal.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -17px; -} - -.tsd-kind-class > .tsd-kind-icon:before { - background-position: 0px -34px; -} -.tsd-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -34px; -} -.tsd-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -34px; -} - -.tsd-kind-class.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -51px; -} -.tsd-kind-class.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -51px; -} - -.tsd-kind-interface > .tsd-kind-icon:before { - background-position: 0px -68px; -} -.tsd-kind-interface.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -68px; -} -.tsd-kind-interface.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -68px; -} - -.tsd-kind-interface.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -85px; -} -.tsd-kind-interface.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -85px; -} - -.tsd-kind-namespace > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-namespace.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-namespace.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-module > .tsd-kind-icon:before { - background-position: 0px -102px; -} -.tsd-kind-module.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -102px; -} -.tsd-kind-module.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -102px; -} - -.tsd-kind-enum > .tsd-kind-icon:before { - background-position: 0px -119px; -} -.tsd-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -119px; -} -.tsd-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -119px; -} - -.tsd-kind-enum-member > .tsd-kind-icon:before { - background-position: 0px -136px; -} -.tsd-kind-enum-member.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -136px; -} -.tsd-kind-enum-member.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -136px; -} - -.tsd-kind-signature > .tsd-kind-icon:before { - background-position: 0px -153px; -} -.tsd-kind-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -153px; -} -.tsd-kind-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -153px; -} - -.tsd-kind-type-alias > .tsd-kind-icon:before { - background-position: 0px -170px; -} -.tsd-kind-type-alias.tsd-is-protected > .tsd-kind-icon:before { - background-position: -17px -170px; -} -.tsd-kind-type-alias.tsd-is-private > .tsd-kind-icon:before { - background-position: -34px -170px; -} - -.tsd-kind-type-alias.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: 0px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -17px -187px; -} -.tsd-kind-type-alias.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -34px -187px; -} - -.tsd-kind-variable > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-variable.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-variable.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-variable.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-variable.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-variable.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-property > .tsd-kind-icon:before { - background-position: -136px -0px; -} -.tsd-kind-property.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -0px; -} -.tsd-kind-property.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -0px; -} -.tsd-kind-property.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -0px; -} -.tsd-kind-property.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -0px; -} -.tsd-kind-property.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -0px; -} - -.tsd-kind-get-signature > .tsd-kind-icon:before { - background-position: -136px -17px; -} -.tsd-kind-get-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -17px; -} -.tsd-kind-get-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -17px; -} -.tsd-kind-get-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -17px; -} - -.tsd-kind-set-signature > .tsd-kind-icon:before { - background-position: -136px -34px; -} -.tsd-kind-set-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -34px; -} -.tsd-kind-set-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -34px; -} -.tsd-kind-set-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -34px; -} - -.tsd-kind-accessor > .tsd-kind-icon:before { - background-position: -136px -51px; -} -.tsd-kind-accessor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -51px; -} -.tsd-kind-accessor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -51px; -} -.tsd-kind-accessor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -51px; -} - -.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-method.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -68px; -} -.tsd-kind-call-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -68px; -} -.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -68px; -} -.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -68px; -} - -.tsd-kind-function.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-function.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-method.tsd-has-type-parameter > .tsd-kind-icon:before { - background-position: -136px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -85px; -} -.tsd-kind-method.tsd-has-type-parameter.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -85px; -} - -.tsd-kind-constructor > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-constructor-signature > .tsd-kind-icon:before { - background-position: -136px -102px; -} -.tsd-kind-constructor-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -102px; -} -.tsd-kind-constructor-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -102px; -} -.tsd-kind-constructor-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -102px; -} - -.tsd-kind-index-signature > .tsd-kind-icon:before { - background-position: -136px -119px; -} -.tsd-kind-index-signature.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -119px; -} -.tsd-kind-index-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -119px; -} -.tsd-kind-index-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -119px; -} - -.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -136px; -} -.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -136px; -} -.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -136px; -} -.tsd-kind-event.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -136px; -} -.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -136px; -} -.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -136px; -} - -.tsd-is-static > .tsd-kind-icon:before { - background-position: -136px -153px; -} -.tsd-is-static.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -153px; -} -.tsd-is-static.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-inherited > .tsd-kind-icon:before { - background-position: -68px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected > .tsd-kind-icon:before { - background-position: -85px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -153px; -} -.tsd-is-static.tsd-parent-kind-class.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-protected > .tsd-kind-icon:before { - background-position: -187px -153px; -} -.tsd-is-static.tsd-parent-kind-enum.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -153px; -} -.tsd-is-static.tsd-parent-kind-interface > .tsd-kind-icon:before { - background-position: -204px -153px; -} -.tsd-is-static.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -153px; -} - -.tsd-is-static.tsd-kind-function > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-function.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-method > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-method.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-call-signature > .tsd-kind-icon:before { - background-position: -136px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -153px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class - > .tsd-kind-icon:before { - background-position: -51px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum - > .tsd-kind-icon:before { - background-position: -170px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -170px; -} -.tsd-is-static.tsd-kind-call-signature.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -170px; -} - -.tsd-is-static.tsd-kind-event > .tsd-kind-icon:before { - background-position: -136px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-protected > .tsd-kind-icon:before { - background-position: -153px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-is-private > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class > .tsd-kind-icon:before { - background-position: -51px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -68px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -85px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-protected.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -102px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-class.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum > .tsd-kind-icon:before { - background-position: -170px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-protected - > .tsd-kind-icon:before { - background-position: -187px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-enum.tsd-is-private - > .tsd-kind-icon:before { - background-position: -119px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface - > .tsd-kind-icon:before { - background-position: -204px -187px; -} -.tsd-is-static.tsd-kind-event.tsd-parent-kind-interface.tsd-is-inherited - > .tsd-kind-icon:before { - background-position: -221px -187px; -} diff --git a/docs/assets/icons.png b/docs/assets/icons.png deleted file mode 100644 index 3836d5f..0000000 Binary files a/docs/assets/icons.png and /dev/null differ diff --git a/docs/assets/icons@2x.png b/docs/assets/icons@2x.png deleted file mode 100644 index 5a209e2..0000000 Binary files a/docs/assets/icons@2x.png and /dev/null differ diff --git a/docs/assets/main.js b/docs/assets/main.js deleted file mode 100644 index 61009a4..0000000 --- a/docs/assets/main.js +++ /dev/null @@ -1,52 +0,0 @@ -(()=>{var Ce=Object.create;var J=Object.defineProperty;var Pe=Object.getOwnPropertyDescriptor;var Oe=Object.getOwnPropertyNames;var Re=Object.getPrototypeOf,_e=Object.prototype.hasOwnProperty;var Me=t=>J(t,"__esModule",{value:!0});var Fe=(t,e)=>()=>(e||t((e={exports:{}}).exports,e),e.exports);var De=(t,e,r)=>{if(e&&typeof e=="object"||typeof e=="function")for(let n of Oe(e))!_e.call(t,n)&&n!=="default"&&J(t,n,{get:()=>e[n],enumerable:!(r=Pe(e,n))||r.enumerable});return t},Ae=t=>De(Me(J(t!=null?Ce(Re(t)):{},"default",t&&t.__esModule&&"default"in t?{get:()=>t.default,enumerable:!0}:{value:t,enumerable:!0})),t);var de=Fe((ue,he)=>{(function(){var t=function(e){var r=new t.Builder;return r.pipeline.add(t.trimmer,t.stopWordFilter,t.stemmer),r.searchPipeline.add(t.stemmer),e.call(r,r),r.build()};t.version="2.3.9";t.utils={},t.utils.warn=function(e){return function(r){e.console&&console.warn&&console.warn(r)}}(this),t.utils.asString=function(e){return e==null?"":e.toString()},t.utils.clone=function(e){if(e==null)return e;for(var r=Object.create(null),n=Object.keys(e),i=0;i0){var h=t.utils.clone(r)||{};h.position=[a,l],h.index=s.length,s.push(new t.Token(n.slice(a,o),h))}a=o+1}}return s},t.tokenizer.separator=/[\s\-]+/;t.Pipeline=function(){this._stack=[]},t.Pipeline.registeredFunctions=Object.create(null),t.Pipeline.registerFunction=function(e,r){r in this.registeredFunctions&&t.utils.warn("Overwriting existing registered function: "+r),e.label=r,t.Pipeline.registeredFunctions[e.label]=e},t.Pipeline.warnIfFunctionNotRegistered=function(e){var r=e.label&&e.label in this.registeredFunctions;r||t.utils.warn(`Function is not registered with pipeline. This may cause problems when serialising the index. -`,e)},t.Pipeline.load=function(e){var r=new t.Pipeline;return e.forEach(function(n){var i=t.Pipeline.registeredFunctions[n];if(i)r.add(i);else throw new Error("Cannot load unregistered function: "+n)}),r},t.Pipeline.prototype.add=function(){var e=Array.prototype.slice.call(arguments);e.forEach(function(r){t.Pipeline.warnIfFunctionNotRegistered(r),this._stack.push(r)},this)},t.Pipeline.prototype.after=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");n=n+1,this._stack.splice(n,0,r)},t.Pipeline.prototype.before=function(e,r){t.Pipeline.warnIfFunctionNotRegistered(r);var n=this._stack.indexOf(e);if(n==-1)throw new Error("Cannot find existingFn");this._stack.splice(n,0,r)},t.Pipeline.prototype.remove=function(e){var r=this._stack.indexOf(e);r!=-1&&this._stack.splice(r,1)},t.Pipeline.prototype.run=function(e){for(var r=this._stack.length,n=0;n1&&(oe&&(n=s),o!=e);)i=n-r,s=r+Math.floor(i/2),o=this.elements[s*2];if(o==e||o>e)return s*2;if(oc?h+=2:a==c&&(r+=n[l+1]*i[h+1],l+=2,h+=2);return r},t.Vector.prototype.similarity=function(e){return this.dot(e)/this.magnitude()||0},t.Vector.prototype.toArray=function(){for(var e=new Array(this.elements.length/2),r=1,n=0;r0){var o=s.str.charAt(0),a;o in s.node.edges?a=s.node.edges[o]:(a=new t.TokenSet,s.node.edges[o]=a),s.str.length==1&&(a.final=!0),i.push({node:a,editsRemaining:s.editsRemaining,str:s.str.slice(1)})}if(s.editsRemaining!=0){if("*"in s.node.edges)var c=s.node.edges["*"];else{var c=new t.TokenSet;s.node.edges["*"]=c}if(s.str.length==0&&(c.final=!0),i.push({node:c,editsRemaining:s.editsRemaining-1,str:s.str}),s.str.length>1&&i.push({node:s.node,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)}),s.str.length==1&&(s.node.final=!0),s.str.length>=1){if("*"in s.node.edges)var l=s.node.edges["*"];else{var l=new t.TokenSet;s.node.edges["*"]=l}s.str.length==1&&(l.final=!0),i.push({node:l,editsRemaining:s.editsRemaining-1,str:s.str.slice(1)})}if(s.str.length>1){var h=s.str.charAt(0),f=s.str.charAt(1),v;f in s.node.edges?v=s.node.edges[f]:(v=new t.TokenSet,s.node.edges[f]=v),s.str.length==1&&(v.final=!0),i.push({node:v,editsRemaining:s.editsRemaining-1,str:h+s.str.slice(2)})}}}return n},t.TokenSet.fromString=function(e){for(var r=new t.TokenSet,n=r,i=0,s=e.length;i=e;r--){var n=this.uncheckedNodes[r],i=n.child.toString();i in this.minimizedNodes?n.parent.edges[n.char]=this.minimizedNodes[i]:(n.child._str=i,this.minimizedNodes[i]=n.child),this.uncheckedNodes.pop()}};t.Index=function(e){this.invertedIndex=e.invertedIndex,this.fieldVectors=e.fieldVectors,this.tokenSet=e.tokenSet,this.fields=e.fields,this.pipeline=e.pipeline},t.Index.prototype.search=function(e){return this.query(function(r){var n=new t.QueryParser(e,r);n.parse()})},t.Index.prototype.query=function(e){for(var r=new t.Query(this.fields),n=Object.create(null),i=Object.create(null),s=Object.create(null),o=Object.create(null),a=Object.create(null),c=0;c1?this._b=1:this._b=e},t.Builder.prototype.k1=function(e){this._k1=e},t.Builder.prototype.add=function(e,r){var n=e[this._ref],i=Object.keys(this._fields);this._documents[n]=r||{},this.documentCount+=1;for(var s=0;s=this.length)return t.QueryLexer.EOS;var e=this.str.charAt(this.pos);return this.pos+=1,e},t.QueryLexer.prototype.width=function(){return this.pos-this.start},t.QueryLexer.prototype.ignore=function(){this.start==this.pos&&(this.pos+=1),this.start=this.pos},t.QueryLexer.prototype.backup=function(){this.pos-=1},t.QueryLexer.prototype.acceptDigitRun=function(){var e,r;do e=this.next(),r=e.charCodeAt(0);while(r>47&&r<58);e!=t.QueryLexer.EOS&&this.backup()},t.QueryLexer.prototype.more=function(){return this.pos1&&(e.backup(),e.emit(t.QueryLexer.TERM)),e.ignore(),e.more())return t.QueryLexer.lexText},t.QueryLexer.lexEditDistance=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.EDIT_DISTANCE),t.QueryLexer.lexText},t.QueryLexer.lexBoost=function(e){return e.ignore(),e.acceptDigitRun(),e.emit(t.QueryLexer.BOOST),t.QueryLexer.lexText},t.QueryLexer.lexEOS=function(e){e.width()>0&&e.emit(t.QueryLexer.TERM)},t.QueryLexer.termSeparator=t.tokenizer.separator,t.QueryLexer.lexText=function(e){for(;;){var r=e.next();if(r==t.QueryLexer.EOS)return t.QueryLexer.lexEOS;if(r.charCodeAt(0)==92){e.escapeCharacter();continue}if(r==":")return t.QueryLexer.lexField;if(r=="~")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexEditDistance;if(r=="^")return e.backup(),e.width()>0&&e.emit(t.QueryLexer.TERM),t.QueryLexer.lexBoost;if(r=="+"&&e.width()===1||r=="-"&&e.width()===1)return e.emit(t.QueryLexer.PRESENCE),t.QueryLexer.lexText;if(r.match(t.QueryLexer.termSeparator))return t.QueryLexer.lexTerm}},t.QueryParser=function(e,r){this.lexer=new t.QueryLexer(e),this.query=r,this.currentClause={},this.lexemeIdx=0},t.QueryParser.prototype.parse=function(){this.lexer.run(),this.lexemes=this.lexer.lexemes;for(var e=t.QueryParser.parseClause;e;)e=e(this);return this.query},t.QueryParser.prototype.peekLexeme=function(){return this.lexemes[this.lexemeIdx]},t.QueryParser.prototype.consumeLexeme=function(){var e=this.peekLexeme();return this.lexemeIdx+=1,e},t.QueryParser.prototype.nextClause=function(){var e=this.currentClause;this.query.clause(e),this.currentClause={}},t.QueryParser.parseClause=function(e){var r=e.peekLexeme();if(r!=null)switch(r.type){case t.QueryLexer.PRESENCE:return t.QueryParser.parsePresence;case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expected either a field or a term, found "+r.type;throw r.str.length>=1&&(n+=" with value '"+r.str+"'"),new t.QueryParseError(n,r.start,r.end)}},t.QueryParser.parsePresence=function(e){var r=e.consumeLexeme();if(r!=null){switch(r.str){case"-":e.currentClause.presence=t.Query.presence.PROHIBITED;break;case"+":e.currentClause.presence=t.Query.presence.REQUIRED;break;default:var n="unrecognised presence operator'"+r.str+"'";throw new t.QueryParseError(n,r.start,r.end)}var i=e.peekLexeme();if(i==null){var n="expecting term or field, found nothing";throw new t.QueryParseError(n,r.start,r.end)}switch(i.type){case t.QueryLexer.FIELD:return t.QueryParser.parseField;case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var n="expecting term or field, found '"+i.type+"'";throw new t.QueryParseError(n,i.start,i.end)}}},t.QueryParser.parseField=function(e){var r=e.consumeLexeme();if(r!=null){if(e.query.allFields.indexOf(r.str)==-1){var n=e.query.allFields.map(function(o){return"'"+o+"'"}).join(", "),i="unrecognised field '"+r.str+"', possible fields: "+n;throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.fields=[r.str];var s=e.peekLexeme();if(s==null){var i="expecting term, found nothing";throw new t.QueryParseError(i,r.start,r.end)}switch(s.type){case t.QueryLexer.TERM:return t.QueryParser.parseTerm;default:var i="expecting term, found '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseTerm=function(e){var r=e.consumeLexeme();if(r!=null){e.currentClause.term=r.str.toLowerCase(),r.str.indexOf("*")!=-1&&(e.currentClause.usePipeline=!1);var n=e.peekLexeme();if(n==null){e.nextClause();return}switch(n.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+n.type+"'";throw new t.QueryParseError(i,n.start,n.end)}}},t.QueryParser.parseEditDistance=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="edit distance must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.editDistance=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},t.QueryParser.parseBoost=function(e){var r=e.consumeLexeme();if(r!=null){var n=parseInt(r.str,10);if(isNaN(n)){var i="boost must be numeric";throw new t.QueryParseError(i,r.start,r.end)}e.currentClause.boost=n;var s=e.peekLexeme();if(s==null){e.nextClause();return}switch(s.type){case t.QueryLexer.TERM:return e.nextClause(),t.QueryParser.parseTerm;case t.QueryLexer.FIELD:return e.nextClause(),t.QueryParser.parseField;case t.QueryLexer.EDIT_DISTANCE:return t.QueryParser.parseEditDistance;case t.QueryLexer.BOOST:return t.QueryParser.parseBoost;case t.QueryLexer.PRESENCE:return e.nextClause(),t.QueryParser.parsePresence;default:var i="Unexpected lexeme type '"+s.type+"'";throw new t.QueryParseError(i,s.start,s.end)}}},function(e,r){typeof define=="function"&&define.amd?define(r):typeof ue=="object"?he.exports=r():e.lunr=r()}(this,function(){return t})})()});var le=[];function N(t,e){le.push({selector:e,constructor:t})}var X=class{constructor(){this.createComponents(document.body)}createComponents(e){le.forEach(r=>{e.querySelectorAll(r.selector).forEach(n=>{n.dataset.hasInstance||(new r.constructor({el:n}),n.dataset.hasInstance=String(!0))})})}};var Q=class{constructor(e){this.el=e.el}};var Z=class{constructor(){this.listeners={}}addEventListener(e,r){e in this.listeners||(this.listeners[e]=[]),this.listeners[e].push(r)}removeEventListener(e,r){if(!(e in this.listeners))return;let n=this.listeners[e];for(let i=0,s=n.length;i{let r=Date.now();return(...n)=>{r+e-Date.now()<0&&(t(...n),r=Date.now())}};var ee=class extends Z{constructor(){super();this.scrollTop=0;this.lastY=0;this.width=0;this.height=0;this.showToolbar=!0;this.toolbar=document.querySelector(".tsd-page-toolbar"),this.secondaryNav=document.querySelector(".tsd-navigation.secondary"),window.addEventListener("scroll",K(()=>this.onScroll(),10)),window.addEventListener("resize",K(()=>this.onResize(),10)),this.onResize(),this.onScroll()}triggerResize(){let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onResize(){this.width=window.innerWidth||0,this.height=window.innerHeight||0;let e=new CustomEvent("resize",{detail:{width:this.width,height:this.height}});this.dispatchEvent(e)}onScroll(){this.scrollTop=window.scrollY||0;let e=new CustomEvent("scroll",{detail:{scrollTop:this.scrollTop}});this.dispatchEvent(e),this.hideShowToolbar()}hideShowToolbar(){var r;let e=this.showToolbar;this.showToolbar=this.lastY>=this.scrollTop||this.scrollTop<=0,e!==this.showToolbar&&(this.toolbar.classList.toggle("tsd-page-toolbar--hide"),(r=this.secondaryNav)==null||r.classList.toggle("tsd-navigation--toolbar-hide")),this.lastY=this.scrollTop}},I=ee;I.instance=new ee;var te=class extends Q{constructor(e){super(e);this.anchors=[];this.index=-1;I.instance.addEventListener("resize",()=>this.onResize()),I.instance.addEventListener("scroll",r=>this.onScroll(r)),this.createAnchors()}createAnchors(){let e=window.location.href;e.indexOf("#")!=-1&&(e=e.substr(0,e.indexOf("#"))),this.el.querySelectorAll("a").forEach(r=>{let n=r.href;if(n.indexOf("#")==-1||n.substr(0,e.length)!=e)return;let i=n.substr(n.indexOf("#")+1),s=document.querySelector("a.tsd-anchor[name="+i+"]"),o=r.parentNode;!s||!o||this.anchors.push({link:o,anchor:s,position:0})}),this.onResize()}onResize(){let e;for(let n=0,i=this.anchors.length;nn.position-i.position);let r=new CustomEvent("scroll",{detail:{scrollTop:I.instance.scrollTop}});this.onScroll(r)}onScroll(e){let r=e.detail.scrollTop+5,n=this.anchors,i=n.length-1,s=this.index;for(;s>-1&&n[s].position>r;)s-=1;for(;s-1&&this.anchors[this.index].link.classList.remove("focus"),this.index=s,this.index>-1&&this.anchors[this.index].link.classList.add("focus"))}};var ce=(t,e=100)=>{let r;return(...n)=>{clearTimeout(r),r=setTimeout(()=>t(n),e)}};var pe=Ae(de());function fe(){let t=document.getElementById("tsd-search");if(!t)return;let e=document.getElementById("search-script");t.classList.add("loading"),e&&(e.addEventListener("error",()=>{t.classList.remove("loading"),t.classList.add("failure")}),e.addEventListener("load",()=>{t.classList.remove("loading"),t.classList.add("ready")}),window.searchData&&t.classList.remove("loading"));let r=document.querySelector("#tsd-search input"),n=document.querySelector("#tsd-search .results");if(!r||!n)throw new Error("The input field or the result list wrapper was not found");let i=!1;n.addEventListener("mousedown",()=>i=!0),n.addEventListener("mouseup",()=>{i=!1,t.classList.remove("has-focus")}),r.addEventListener("focus",()=>t.classList.add("has-focus")),r.addEventListener("blur",()=>{i||(i=!1,t.classList.remove("has-focus"))});let s={base:t.dataset.base+"/"};Ve(t,n,r,s)}function Ve(t,e,r,n){r.addEventListener("input",ce(()=>{ze(t,e,r,n)},200));let i=!1;r.addEventListener("keydown",s=>{i=!0,s.key=="Enter"?Ne(e,r):s.key=="Escape"?r.blur():s.key=="ArrowUp"?me(e,-1):s.key==="ArrowDown"?me(e,1):i=!1}),r.addEventListener("keypress",s=>{i&&s.preventDefault()}),document.body.addEventListener("keydown",s=>{s.altKey||s.ctrlKey||s.metaKey||!r.matches(":focus")&&s.key==="/"&&(r.focus(),s.preventDefault())})}function He(t,e){t.index||window.searchData&&(e.classList.remove("loading"),e.classList.add("ready"),t.data=window.searchData,t.index=pe.Index.load(window.searchData.index))}function ze(t,e,r,n){if(He(n,t),!n.index||!n.data)return;e.textContent="";let i=r.value.trim(),s=n.index.search(`*${i}*`);for(let o=0,a=Math.min(10,s.length);o${ve(c.parent,i)}.${l}`);let h=document.createElement("li");h.classList.value=c.classes;let f=document.createElement("a");f.href=n.base+c.url,f.classList.add("tsd-kind-icon"),f.innerHTML=l,h.append(f),e.appendChild(h)}}function me(t,e){let r=t.querySelector(".current");if(!r)r=t.querySelector(e==1?"li:first-child":"li:last-child"),r&&r.classList.add("current");else{let n=r;if(e===1)do n=n.nextElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);else do n=n.previousElementSibling;while(n instanceof HTMLElement&&n.offsetParent==null);n&&(r.classList.remove("current"),n.classList.add("current"))}}function Ne(t,e){let r=t.querySelector(".current");if(r||(r=t.querySelector("li:first-child")),r){let n=r.querySelector("a");n&&(window.location.href=n.href),e.blur()}}function ve(t,e){if(e==="")return t;let r=t.toLocaleLowerCase(),n=e.toLocaleLowerCase(),i=[],s=0,o=r.indexOf(n);for(;o!=-1;)i.push(re(t.substring(s,o)),`${re(t.substring(o,o+n.length))}`),s=o+n.length,o=r.indexOf(n,s);return i.push(re(t.substring(s))),i.join("")}var je={"&":"&","<":"<",">":">","'":"'",'"':"""};function re(t){return t.replace(/[&<>"'"]/g,e=>je[e])}var ge=class{constructor(e,r){this.signature=e,this.description=r}addClass(e){return this.signature.classList.add(e),this.description.classList.add(e),this}removeClass(e){return this.signature.classList.remove(e),this.description.classList.remove(e),this}},ne=class extends Q{constructor(e){super(e);this.groups=[];this.index=-1;this.createGroups(),this.container&&(this.el.classList.add("active"),Array.from(this.el.children).forEach(r=>{r.addEventListener("touchstart",n=>this.onClick(n)),r.addEventListener("click",n=>this.onClick(n))}),this.container.classList.add("active"),this.setIndex(0))}setIndex(e){if(e<0&&(e=0),e>this.groups.length-1&&(e=this.groups.length-1),this.index==e)return;let r=this.groups[e];if(this.index>-1){let n=this.groups[this.index];n.removeClass("current").addClass("fade-out"),r.addClass("current"),r.addClass("fade-in"),I.instance.triggerResize(),setTimeout(()=>{n.removeClass("fade-out"),r.removeClass("fade-in")},300)}else r.addClass("current"),I.instance.triggerResize();this.index=e}createGroups(){let e=this.el.children;if(e.length<2)return;this.container=this.el.nextElementSibling;let r=this.container.children;this.groups=[];for(let n=0;n{r.signature===e.currentTarget&&this.setIndex(n)})}};var C="mousedown",ye="mousemove",_="mouseup",G={x:0,y:0},xe=!1,ie=!1,Be=!1,A=!1,Le=/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent);document.documentElement.classList.add(Le?"is-mobile":"not-mobile");Le&&"ontouchstart"in document.documentElement&&(Be=!0,C="touchstart",ye="touchmove",_="touchend");document.addEventListener(C,t=>{ie=!0,A=!1;let e=C=="touchstart"?t.targetTouches[0]:t;G.y=e.pageY||0,G.x=e.pageX||0});document.addEventListener(ye,t=>{if(!!ie&&!A){let e=C=="touchstart"?t.targetTouches[0]:t,r=G.x-(e.pageX||0),n=G.y-(e.pageY||0);A=Math.sqrt(r*r+n*n)>10}});document.addEventListener(_,()=>{ie=!1});document.addEventListener("click",t=>{xe&&(t.preventDefault(),t.stopImmediatePropagation(),xe=!1)});var se=class extends Q{constructor(e){super(e);this.className=this.el.dataset.toggle||"",this.el.addEventListener(_,r=>this.onPointerUp(r)),this.el.addEventListener("click",r=>r.preventDefault()),document.addEventListener(C,r=>this.onDocumentPointerDown(r)),document.addEventListener(_,r=>this.onDocumentPointerUp(r))}setActive(e){if(this.active==e)return;this.active=e,document.documentElement.classList.toggle("has-"+this.className,e),this.el.classList.toggle("active",e);let r=(this.active?"to-has-":"from-has-")+this.className;document.documentElement.classList.add(r),setTimeout(()=>document.documentElement.classList.remove(r),500)}onPointerUp(e){A||(this.setActive(!0),e.preventDefault())}onDocumentPointerDown(e){if(this.active){if(e.target.closest(".col-menu, .tsd-filter-group"))return;this.setActive(!1)}}onDocumentPointerUp(e){if(!A&&this.active&&e.target.closest(".col-menu")){let r=e.target.closest("a");if(r){let n=window.location.href;n.indexOf("#")!=-1&&(n=n.substr(0,n.indexOf("#"))),r.href.substr(0,n.length)==n&&setTimeout(()=>this.setActive(!1),250)}}}};var oe=class{constructor(e,r){this.key=e,this.value=r,this.defaultValue=r,this.initialize(),window.localStorage[this.key]&&this.setValue(this.fromLocalStorage(window.localStorage[this.key]))}initialize(){}setValue(e){if(this.value==e)return;let r=this.value;this.value=e,window.localStorage[this.key]=this.toLocalStorage(e),this.handleValueChange(r,e)}},ae=class extends oe{initialize(){let e=document.querySelector("#tsd-filter-"+this.key);!e||(this.checkbox=e,this.checkbox.addEventListener("change",()=>{this.setValue(this.checkbox.checked)}))}handleValueChange(e,r){!this.checkbox||(this.checkbox.checked=this.value,document.documentElement.classList.toggle("toggle-"+this.key,this.value!=this.defaultValue))}fromLocalStorage(e){return e=="true"}toLocalStorage(e){return e?"true":"false"}},Ee=class extends oe{initialize(){document.documentElement.classList.add("toggle-"+this.key+this.value);let e=document.querySelector("#tsd-filter-"+this.key);if(!e)return;this.select=e;let r=()=>{this.select.classList.add("active")},n=()=>{this.select.classList.remove("active")};this.select.addEventListener(C,r),this.select.addEventListener("mouseover",r),this.select.addEventListener("mouseleave",n),this.select.querySelectorAll("li").forEach(i=>{i.addEventListener(_,s=>{e.classList.remove("active"),this.setValue(s.target.dataset.value||"")})}),document.addEventListener(C,i=>{this.select.contains(i.target)||this.select.classList.remove("active")})}handleValueChange(e,r){this.select.querySelectorAll("li.selected").forEach(s=>{s.classList.remove("selected")});let n=this.select.querySelector('li[data-value="'+r+'"]'),i=this.select.querySelector(".tsd-select-label");n&&i&&(n.classList.add("selected"),i.textContent=n.textContent),document.documentElement.classList.remove("toggle-"+e),document.documentElement.classList.add("toggle-"+r)}fromLocalStorage(e){return e}toLocalStorage(e){return e}},Y=class extends Q{constructor(e){super(e);this.optionVisibility=new Ee("visibility","private"),this.optionInherited=new ae("inherited",!0),this.optionExternals=new ae("externals",!0)}static isSupported(){try{return typeof window.localStorage!="undefined"}catch{return!1}}};function be(t){let e=localStorage.getItem("tsd-theme")||"os";t.value=e,we(e),t.addEventListener("change",()=>{localStorage.setItem("tsd-theme",t.value),we(t.value)})}function we(t){switch(t){case"os":document.body.classList.remove("light","dark");break;case"light":document.body.classList.remove("dark"),document.body.classList.add("light");break;case"dark":document.body.classList.remove("light"),document.body.classList.add("dark");break}}fe();N(te,".menu-highlight");N(ne,".tsd-signatures");N(se,"a[data-toggle]");Y.isSupported()?N(Y,"#tsd-filter"):document.documentElement.classList.add("no-filter");var Te=document.getElementById("theme");Te&&be(Te);var qe=new X;Object.defineProperty(window,"app",{value:qe});})(); -/*! - * lunr.Builder - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Index - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Pipeline - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Set - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.TokenSet - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.Vector - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.stemmer - * Copyright (C) 2020 Oliver Nightingale - * Includes code from - http://tartarus.org/~martin/PorterStemmer/js.txt - */ -/*! - * lunr.stopWordFilter - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.tokenizer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.trimmer - * Copyright (C) 2020 Oliver Nightingale - */ -/*! - * lunr.utils - * Copyright (C) 2020 Oliver Nightingale - */ -/** - * lunr - http://lunrjs.com - A bit like Solr, but much smaller and not as bright - 2.3.9 - * Copyright (C) 2020 Oliver Nightingale - * @license MIT - */ diff --git a/docs/assets/search.js b/docs/assets/search.js deleted file mode 100644 index 30d1dd5..0000000 --- a/docs/assets/search.js +++ /dev/null @@ -1 +0,0 @@ -window.searchData = {"kinds":{"4":"Namespace","8":"Enumeration","16":"Enumeration member","64":"Function","128":"Class","256":"Interface","512":"Constructor","1024":"Property","2048":"Method","65536":"Type literal","262144":"Accessor","4194304":"Type alias"},"rows":[{"id":0,"kind":64,"name":"stream","url":"modules.html#stream","classes":"tsd-kind-function"},{"id":1,"kind":64,"name":"search","url":"modules.html#search","classes":"tsd-kind-function"},{"id":2,"kind":64,"name":"stream_from_info","url":"modules.html#stream_from_info","classes":"tsd-kind-function"},{"id":3,"kind":64,"name":"validate","url":"modules.html#validate","classes":"tsd-kind-function"},{"id":4,"kind":64,"name":"authorization","url":"modules.html#authorization","classes":"tsd-kind-function"},{"id":5,"kind":64,"name":"attachListeners","url":"modules.html#attachListeners","classes":"tsd-kind-function"},{"id":6,"kind":64,"name":"playlist_info","url":"modules.html#playlist_info","classes":"tsd-kind-function"},{"id":7,"kind":64,"name":"video_basic_info","url":"modules.html#video_basic_info","classes":"tsd-kind-function"},{"id":8,"kind":64,"name":"video_info","url":"modules.html#video_info","classes":"tsd-kind-function"},{"id":9,"kind":64,"name":"decipher_info","url":"modules.html#decipher_info","classes":"tsd-kind-function"},{"id":10,"kind":64,"name":"yt_validate","url":"modules.html#yt_validate","classes":"tsd-kind-function"},{"id":11,"kind":64,"name":"extractID","url":"modules.html#extractID","classes":"tsd-kind-function"},{"id":12,"kind":4194304,"name":"YouTube","url":"modules.html#YouTube","classes":"tsd-kind-type-alias"},{"id":13,"kind":4194304,"name":"YouTubeStream","url":"modules.html#YouTubeStream","classes":"tsd-kind-type-alias"},{"id":14,"kind":64,"name":"cookieHeaders","url":"modules.html#cookieHeaders","classes":"tsd-kind-function"},{"id":15,"kind":64,"name":"spotify","url":"modules.html#spotify","classes":"tsd-kind-function"},{"id":16,"kind":64,"name":"sp_validate","url":"modules.html#sp_validate","classes":"tsd-kind-function"},{"id":17,"kind":64,"name":"refreshToken","url":"modules.html#refreshToken","classes":"tsd-kind-function"},{"id":18,"kind":64,"name":"is_expired","url":"modules.html#is_expired","classes":"tsd-kind-function"},{"id":19,"kind":4194304,"name":"Spotify","url":"modules.html#Spotify","classes":"tsd-kind-type-alias"},{"id":20,"kind":64,"name":"soundcloud","url":"modules.html#soundcloud","classes":"tsd-kind-function"},{"id":21,"kind":64,"name":"so_validate","url":"modules.html#so_validate","classes":"tsd-kind-function"},{"id":22,"kind":4194304,"name":"SoundCloud","url":"modules.html#SoundCloud","classes":"tsd-kind-type-alias"},{"id":23,"kind":128,"name":"SoundCloudStream","url":"classes/SoundCloudStream.html","classes":"tsd-kind-class"},{"id":24,"kind":512,"name":"constructor","url":"classes/SoundCloudStream.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":"SoundCloudStream"},{"id":25,"kind":1024,"name":"stream","url":"classes/SoundCloudStream.html#stream","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SoundCloudStream"},{"id":26,"kind":1024,"name":"type","url":"classes/SoundCloudStream.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":"SoundCloudStream"},{"id":27,"kind":1024,"name":"url","url":"classes/SoundCloudStream.html#url","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":28,"kind":1024,"name":"downloaded_time","url":"classes/SoundCloudStream.html#downloaded_time","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":29,"kind":1024,"name":"timer","url":"classes/SoundCloudStream.html#timer","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":30,"kind":1024,"name":"downloaded_segments","url":"classes/SoundCloudStream.html#downloaded_segments","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":31,"kind":1024,"name":"request","url":"classes/SoundCloudStream.html#request","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":32,"kind":1024,"name":"time","url":"classes/SoundCloudStream.html#time","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":33,"kind":1024,"name":"segment_urls","url":"classes/SoundCloudStream.html#segment_urls","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":34,"kind":2048,"name":"parser","url":"classes/SoundCloudStream.html#parser","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":35,"kind":2048,"name":"start","url":"classes/SoundCloudStream.html#start","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":36,"kind":2048,"name":"loop","url":"classes/SoundCloudStream.html#loop","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":37,"kind":2048,"name":"cleanup","url":"classes/SoundCloudStream.html#cleanup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":"SoundCloudStream"},{"id":38,"kind":2048,"name":"pause","url":"classes/SoundCloudStream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SoundCloudStream"},{"id":39,"kind":2048,"name":"resume","url":"classes/SoundCloudStream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":"SoundCloudStream"},{"id":40,"kind":64,"name":"getFreeClientID","url":"modules.html#getFreeClientID","classes":"tsd-kind-function"},{"id":41,"kind":64,"name":"deezer","url":"modules.html#deezer","classes":"tsd-kind-function"},{"id":42,"kind":64,"name":"dz_validate","url":"modules.html#dz_validate","classes":"tsd-kind-function"},{"id":43,"kind":64,"name":"dz_advanced_track_search","url":"modules.html#dz_advanced_track_search","classes":"tsd-kind-function"},{"id":44,"kind":4194304,"name":"Deezer","url":"modules.html#Deezer","classes":"tsd-kind-type-alias"},{"id":45,"kind":64,"name":"setToken","url":"modules.html#setToken","classes":"tsd-kind-function"},{"id":46,"kind":4,"name":"","url":"modules/_internal_.html","classes":"tsd-kind-namespace"},{"id":47,"kind":128,"name":"YouTubeVideo","url":"classes/_internal_.YouTubeVideo.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":48,"kind":512,"name":"constructor","url":"classes/_internal_.YouTubeVideo.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":49,"kind":1024,"name":"id","url":"classes/_internal_.YouTubeVideo.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":50,"kind":1024,"name":"url","url":"classes/_internal_.YouTubeVideo.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":51,"kind":1024,"name":"type","url":"classes/_internal_.YouTubeVideo.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":52,"kind":1024,"name":"title","url":"classes/_internal_.YouTubeVideo.html#title","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":53,"kind":1024,"name":"description","url":"classes/_internal_.YouTubeVideo.html#description","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":54,"kind":1024,"name":"durationRaw","url":"classes/_internal_.YouTubeVideo.html#durationRaw","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":55,"kind":1024,"name":"durationInSec","url":"classes/_internal_.YouTubeVideo.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":56,"kind":1024,"name":"uploadedAt","url":"classes/_internal_.YouTubeVideo.html#uploadedAt","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":57,"kind":1024,"name":"views","url":"classes/_internal_.YouTubeVideo.html#views","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":58,"kind":1024,"name":"thumbnail","url":"classes/_internal_.YouTubeVideo.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":59,"kind":1024,"name":"channel","url":"classes/_internal_.YouTubeVideo.html#channel","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":60,"kind":1024,"name":"likes","url":"classes/_internal_.YouTubeVideo.html#likes","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":61,"kind":1024,"name":"dislikes","url":"classes/_internal_.YouTubeVideo.html#dislikes","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":62,"kind":1024,"name":"live","url":"classes/_internal_.YouTubeVideo.html#live","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":63,"kind":1024,"name":"private","url":"classes/_internal_.YouTubeVideo.html#private","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":64,"kind":1024,"name":"tags","url":"classes/_internal_.YouTubeVideo.html#tags","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":65,"kind":2048,"name":"toString","url":"classes/_internal_.YouTubeVideo.html#toString","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":66,"kind":2048,"name":"toJSON","url":"classes/_internal_.YouTubeVideo.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubeVideo"},{"id":67,"kind":128,"name":"YouTubeChannel","url":"classes/_internal_.YouTubeChannel.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":68,"kind":512,"name":"constructor","url":"classes/_internal_.YouTubeChannel.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":69,"kind":1024,"name":"name","url":"classes/_internal_.YouTubeChannel.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":70,"kind":1024,"name":"verified","url":"classes/_internal_.YouTubeChannel.html#verified","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":71,"kind":1024,"name":"artist","url":"classes/_internal_.YouTubeChannel.html#artist","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":72,"kind":1024,"name":"id","url":"classes/_internal_.YouTubeChannel.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":73,"kind":1024,"name":"type","url":"classes/_internal_.YouTubeChannel.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":74,"kind":1024,"name":"url","url":"classes/_internal_.YouTubeChannel.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":75,"kind":1024,"name":"icon","url":"classes/_internal_.YouTubeChannel.html#icon","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":76,"kind":1024,"name":"subscribers","url":"classes/_internal_.YouTubeChannel.html#subscribers","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":77,"kind":2048,"name":"iconURL","url":"classes/_internal_.YouTubeChannel.html#iconURL","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":78,"kind":2048,"name":"toString","url":"classes/_internal_.YouTubeChannel.html#toString","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":79,"kind":2048,"name":"toJSON","url":"classes/_internal_.YouTubeChannel.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubeChannel"},{"id":80,"kind":128,"name":"YouTubePlayList","url":"classes/_internal_.YouTubePlayList.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":81,"kind":512,"name":"constructor","url":"classes/_internal_.YouTubePlayList.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":82,"kind":1024,"name":"id","url":"classes/_internal_.YouTubePlayList.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":83,"kind":1024,"name":"title","url":"classes/_internal_.YouTubePlayList.html#title","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":84,"kind":1024,"name":"type","url":"classes/_internal_.YouTubePlayList.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":85,"kind":1024,"name":"videoCount","url":"classes/_internal_.YouTubePlayList.html#videoCount","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":86,"kind":1024,"name":"lastUpdate","url":"classes/_internal_.YouTubePlayList.html#lastUpdate","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":87,"kind":1024,"name":"views","url":"classes/_internal_.YouTubePlayList.html#views","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":88,"kind":1024,"name":"url","url":"classes/_internal_.YouTubePlayList.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":89,"kind":1024,"name":"link","url":"classes/_internal_.YouTubePlayList.html#link","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":90,"kind":1024,"name":"channel","url":"classes/_internal_.YouTubePlayList.html#channel","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":91,"kind":1024,"name":"thumbnail","url":"classes/_internal_.YouTubePlayList.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":92,"kind":1024,"name":"videos","url":"classes/_internal_.YouTubePlayList.html#videos","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".YouTubePlayList"},{"id":93,"kind":1024,"name":"fetched_videos","url":"classes/_internal_.YouTubePlayList.html#fetched_videos","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".YouTubePlayList"},{"id":94,"kind":1024,"name":"_continuation","url":"classes/_internal_.YouTubePlayList.html#_continuation","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".YouTubePlayList"},{"id":95,"kind":65536,"name":"__type","url":"classes/_internal_.YouTubePlayList.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":96,"kind":1024,"name":"api","url":"classes/_internal_.YouTubePlayList.html#__type.api","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".YouTubePlayList.__type"},{"id":97,"kind":1024,"name":"token","url":"classes/_internal_.YouTubePlayList.html#__type.token","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".YouTubePlayList.__type"},{"id":98,"kind":1024,"name":"clientVersion","url":"classes/_internal_.YouTubePlayList.html#__type.clientVersion","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".YouTubePlayList.__type"},{"id":99,"kind":1024,"name":"__count","url":"classes/_internal_.YouTubePlayList.html#__count","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".YouTubePlayList"},{"id":100,"kind":2048,"name":"__patch","url":"classes/_internal_.YouTubePlayList.html#__patch","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".YouTubePlayList"},{"id":101,"kind":2048,"name":"__patchSearch","url":"classes/_internal_.YouTubePlayList.html#__patchSearch","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".YouTubePlayList"},{"id":102,"kind":2048,"name":"next","url":"classes/_internal_.YouTubePlayList.html#next","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":103,"kind":2048,"name":"fetch","url":"classes/_internal_.YouTubePlayList.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":104,"kind":2048,"name":"page","url":"classes/_internal_.YouTubePlayList.html#page","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":105,"kind":262144,"name":"total_pages","url":"classes/_internal_.YouTubePlayList.html#total_pages","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":106,"kind":262144,"name":"total_videos","url":"classes/_internal_.YouTubePlayList.html#total_videos","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":107,"kind":2048,"name":"toJSON","url":"classes/_internal_.YouTubePlayList.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubePlayList"},{"id":108,"kind":128,"name":"Stream","url":"classes/_internal_.Stream.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":109,"kind":512,"name":"constructor","url":"classes/_internal_.Stream.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".Stream"},{"id":110,"kind":1024,"name":"stream","url":"classes/_internal_.Stream.html#stream","classes":"tsd-kind-property tsd-parent-kind-class","parent":".Stream"},{"id":111,"kind":1024,"name":"type","url":"classes/_internal_.Stream.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".Stream"},{"id":112,"kind":1024,"name":"url","url":"classes/_internal_.Stream.html#url","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":113,"kind":1024,"name":"bytes_count","url":"classes/_internal_.Stream.html#bytes_count","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":114,"kind":1024,"name":"per_sec_bytes","url":"classes/_internal_.Stream.html#per_sec_bytes","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":115,"kind":1024,"name":"content_length","url":"classes/_internal_.Stream.html#content_length","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":116,"kind":1024,"name":"video_url","url":"classes/_internal_.Stream.html#video_url","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":117,"kind":1024,"name":"timer","url":"classes/_internal_.Stream.html#timer","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":118,"kind":1024,"name":"quality","url":"classes/_internal_.Stream.html#quality","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":119,"kind":1024,"name":"proxy","url":"classes/_internal_.Stream.html#proxy","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":120,"kind":1024,"name":"request","url":"classes/_internal_.Stream.html#request","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":121,"kind":2048,"name":"retry","url":"classes/_internal_.Stream.html#retry","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":122,"kind":2048,"name":"cleanup","url":"classes/_internal_.Stream.html#cleanup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":123,"kind":2048,"name":"loop","url":"classes/_internal_.Stream.html#loop","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".Stream"},{"id":124,"kind":2048,"name":"pause","url":"classes/_internal_.Stream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":".Stream"},{"id":125,"kind":2048,"name":"resume","url":"classes/_internal_.Stream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":".Stream"},{"id":126,"kind":128,"name":"LiveStream","url":"classes/_internal_.LiveStream.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":127,"kind":512,"name":"constructor","url":"classes/_internal_.LiveStream.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".LiveStream"},{"id":128,"kind":1024,"name":"stream","url":"classes/_internal_.LiveStream.html#stream","classes":"tsd-kind-property tsd-parent-kind-class","parent":".LiveStream"},{"id":129,"kind":1024,"name":"type","url":"classes/_internal_.LiveStream.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".LiveStream"},{"id":130,"kind":1024,"name":"base_url","url":"classes/_internal_.LiveStream.html#base_url","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":131,"kind":1024,"name":"url","url":"classes/_internal_.LiveStream.html#url","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":132,"kind":1024,"name":"interval","url":"classes/_internal_.LiveStream.html#interval","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":133,"kind":1024,"name":"packet_count","url":"classes/_internal_.LiveStream.html#packet_count","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":134,"kind":1024,"name":"timer","url":"classes/_internal_.LiveStream.html#timer","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":135,"kind":1024,"name":"video_url","url":"classes/_internal_.LiveStream.html#video_url","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":136,"kind":1024,"name":"dash_timer","url":"classes/_internal_.LiveStream.html#dash_timer","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":137,"kind":1024,"name":"segments_urls","url":"classes/_internal_.LiveStream.html#segments_urls","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":138,"kind":1024,"name":"request","url":"classes/_internal_.LiveStream.html#request","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":139,"kind":2048,"name":"dash_updater","url":"classes/_internal_.LiveStream.html#dash_updater","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":140,"kind":2048,"name":"dash_getter","url":"classes/_internal_.LiveStream.html#dash_getter","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":141,"kind":2048,"name":"cleanup","url":"classes/_internal_.LiveStream.html#cleanup","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":142,"kind":2048,"name":"start","url":"classes/_internal_.LiveStream.html#start","classes":"tsd-kind-method tsd-parent-kind-class tsd-is-private","parent":".LiveStream"},{"id":143,"kind":2048,"name":"pause","url":"classes/_internal_.LiveStream.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":".LiveStream"},{"id":144,"kind":2048,"name":"resume","url":"classes/_internal_.LiveStream.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":".LiveStream"},{"id":145,"kind":128,"name":"SpotifyAlbum","url":"classes/_internal_.SpotifyAlbum.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":146,"kind":512,"name":"constructor","url":"classes/_internal_.SpotifyAlbum.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":147,"kind":1024,"name":"name","url":"classes/_internal_.SpotifyAlbum.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":148,"kind":1024,"name":"type","url":"classes/_internal_.SpotifyAlbum.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":149,"kind":1024,"name":"url","url":"classes/_internal_.SpotifyAlbum.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":150,"kind":1024,"name":"id","url":"classes/_internal_.SpotifyAlbum.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":151,"kind":1024,"name":"thumbnail","url":"classes/_internal_.SpotifyAlbum.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":152,"kind":1024,"name":"artists","url":"classes/_internal_.SpotifyAlbum.html#artists","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":153,"kind":1024,"name":"copyrights","url":"classes/_internal_.SpotifyAlbum.html#copyrights","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":154,"kind":1024,"name":"release_date","url":"classes/_internal_.SpotifyAlbum.html#release_date","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":155,"kind":1024,"name":"release_date_precision","url":"classes/_internal_.SpotifyAlbum.html#release_date_precision","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":156,"kind":1024,"name":"tracksCount","url":"classes/_internal_.SpotifyAlbum.html#tracksCount","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":157,"kind":1024,"name":"spotifyData","url":"classes/_internal_.SpotifyAlbum.html#spotifyData","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".SpotifyAlbum"},{"id":158,"kind":1024,"name":"fetched_tracks","url":"classes/_internal_.SpotifyAlbum.html#fetched_tracks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".SpotifyAlbum"},{"id":159,"kind":2048,"name":"fetch","url":"classes/_internal_.SpotifyAlbum.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":160,"kind":2048,"name":"page","url":"classes/_internal_.SpotifyAlbum.html#page","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":161,"kind":262144,"name":"total_pages","url":"classes/_internal_.SpotifyAlbum.html#total_pages","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":162,"kind":262144,"name":"total_tracks","url":"classes/_internal_.SpotifyAlbum.html#total_tracks","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":163,"kind":2048,"name":"toJSON","url":"classes/_internal_.SpotifyAlbum.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SpotifyAlbum"},{"id":164,"kind":128,"name":"SpotifyPlaylist","url":"classes/_internal_.SpotifyPlaylist.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":165,"kind":512,"name":"constructor","url":"classes/_internal_.SpotifyPlaylist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":166,"kind":1024,"name":"name","url":"classes/_internal_.SpotifyPlaylist.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":167,"kind":1024,"name":"type","url":"classes/_internal_.SpotifyPlaylist.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":168,"kind":1024,"name":"collaborative","url":"classes/_internal_.SpotifyPlaylist.html#collaborative","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":169,"kind":1024,"name":"description","url":"classes/_internal_.SpotifyPlaylist.html#description","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":170,"kind":1024,"name":"url","url":"classes/_internal_.SpotifyPlaylist.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":171,"kind":1024,"name":"id","url":"classes/_internal_.SpotifyPlaylist.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":172,"kind":1024,"name":"thumbnail","url":"classes/_internal_.SpotifyPlaylist.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":173,"kind":1024,"name":"owner","url":"classes/_internal_.SpotifyPlaylist.html#owner","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":174,"kind":1024,"name":"tracksCount","url":"classes/_internal_.SpotifyPlaylist.html#tracksCount","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":175,"kind":1024,"name":"spotifyData","url":"classes/_internal_.SpotifyPlaylist.html#spotifyData","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".SpotifyPlaylist"},{"id":176,"kind":1024,"name":"fetched_tracks","url":"classes/_internal_.SpotifyPlaylist.html#fetched_tracks","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".SpotifyPlaylist"},{"id":177,"kind":2048,"name":"fetch","url":"classes/_internal_.SpotifyPlaylist.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":178,"kind":2048,"name":"page","url":"classes/_internal_.SpotifyPlaylist.html#page","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":179,"kind":262144,"name":"total_pages","url":"classes/_internal_.SpotifyPlaylist.html#total_pages","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":180,"kind":262144,"name":"total_tracks","url":"classes/_internal_.SpotifyPlaylist.html#total_tracks","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":181,"kind":2048,"name":"toJSON","url":"classes/_internal_.SpotifyPlaylist.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SpotifyPlaylist"},{"id":182,"kind":128,"name":"SpotifyTrack","url":"classes/_internal_.SpotifyTrack.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":183,"kind":512,"name":"constructor","url":"classes/_internal_.SpotifyTrack.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":184,"kind":1024,"name":"name","url":"classes/_internal_.SpotifyTrack.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":185,"kind":1024,"name":"type","url":"classes/_internal_.SpotifyTrack.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":186,"kind":1024,"name":"id","url":"classes/_internal_.SpotifyTrack.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":187,"kind":1024,"name":"url","url":"classes/_internal_.SpotifyTrack.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":188,"kind":1024,"name":"explicit","url":"classes/_internal_.SpotifyTrack.html#explicit","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":189,"kind":1024,"name":"durationInSec","url":"classes/_internal_.SpotifyTrack.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":190,"kind":1024,"name":"durationInMs","url":"classes/_internal_.SpotifyTrack.html#durationInMs","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":191,"kind":1024,"name":"artists","url":"classes/_internal_.SpotifyTrack.html#artists","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":192,"kind":1024,"name":"album","url":"classes/_internal_.SpotifyTrack.html#album","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":193,"kind":1024,"name":"thumbnail","url":"classes/_internal_.SpotifyTrack.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":194,"kind":2048,"name":"toJSON","url":"classes/_internal_.SpotifyTrack.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SpotifyTrack"},{"id":195,"kind":128,"name":"SoundCloudTrack","url":"classes/_internal_.SoundCloudTrack.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":196,"kind":512,"name":"constructor","url":"classes/_internal_.SoundCloudTrack.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":197,"kind":1024,"name":"name","url":"classes/_internal_.SoundCloudTrack.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":198,"kind":1024,"name":"id","url":"classes/_internal_.SoundCloudTrack.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":199,"kind":1024,"name":"url","url":"classes/_internal_.SoundCloudTrack.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":200,"kind":1024,"name":"fetched","url":"classes/_internal_.SoundCloudTrack.html#fetched","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":201,"kind":1024,"name":"type","url":"classes/_internal_.SoundCloudTrack.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":202,"kind":1024,"name":"durationInSec","url":"classes/_internal_.SoundCloudTrack.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":203,"kind":1024,"name":"durationInMs","url":"classes/_internal_.SoundCloudTrack.html#durationInMs","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":204,"kind":1024,"name":"formats","url":"classes/_internal_.SoundCloudTrack.html#formats","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":205,"kind":1024,"name":"publisher","url":"classes/_internal_.SoundCloudTrack.html#publisher","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":206,"kind":1024,"name":"thumbnail","url":"classes/_internal_.SoundCloudTrack.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":207,"kind":1024,"name":"user","url":"classes/_internal_.SoundCloudTrack.html#user","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":208,"kind":2048,"name":"toJSON","url":"classes/_internal_.SoundCloudTrack.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SoundCloudTrack"},{"id":209,"kind":128,"name":"SoundCloudPlaylist","url":"classes/_internal_.SoundCloudPlaylist.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":210,"kind":512,"name":"constructor","url":"classes/_internal_.SoundCloudPlaylist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":211,"kind":1024,"name":"name","url":"classes/_internal_.SoundCloudPlaylist.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":212,"kind":1024,"name":"id","url":"classes/_internal_.SoundCloudPlaylist.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":213,"kind":1024,"name":"url","url":"classes/_internal_.SoundCloudPlaylist.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":214,"kind":1024,"name":"type","url":"classes/_internal_.SoundCloudPlaylist.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":215,"kind":1024,"name":"sub_type","url":"classes/_internal_.SoundCloudPlaylist.html#sub_type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":216,"kind":1024,"name":"durationInSec","url":"classes/_internal_.SoundCloudPlaylist.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":217,"kind":1024,"name":"durationInMs","url":"classes/_internal_.SoundCloudPlaylist.html#durationInMs","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":218,"kind":1024,"name":"client_id","url":"classes/_internal_.SoundCloudPlaylist.html#client_id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":219,"kind":1024,"name":"user","url":"classes/_internal_.SoundCloudPlaylist.html#user","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":220,"kind":1024,"name":"tracks","url":"classes/_internal_.SoundCloudPlaylist.html#tracks","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":221,"kind":1024,"name":"tracksCount","url":"classes/_internal_.SoundCloudPlaylist.html#tracksCount","classes":"tsd-kind-property tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":222,"kind":2048,"name":"fetch","url":"classes/_internal_.SoundCloudPlaylist.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":223,"kind":262144,"name":"total_tracks","url":"classes/_internal_.SoundCloudPlaylist.html#total_tracks","classes":"tsd-kind-get-signature tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":224,"kind":2048,"name":"toJSON","url":"classes/_internal_.SoundCloudPlaylist.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".SoundCloudPlaylist"},{"id":225,"kind":128,"name":"DeezerTrack","url":"classes/_internal_.DeezerTrack.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":226,"kind":512,"name":"constructor","url":"classes/_internal_.DeezerTrack.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".DeezerTrack"},{"id":227,"kind":1024,"name":"id","url":"classes/_internal_.DeezerTrack.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":228,"kind":1024,"name":"title","url":"classes/_internal_.DeezerTrack.html#title","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":229,"kind":1024,"name":"shortTitle","url":"classes/_internal_.DeezerTrack.html#shortTitle","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":230,"kind":1024,"name":"url","url":"classes/_internal_.DeezerTrack.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":231,"kind":1024,"name":"durationInSec","url":"classes/_internal_.DeezerTrack.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":232,"kind":1024,"name":"rank","url":"classes/_internal_.DeezerTrack.html#rank","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":233,"kind":1024,"name":"explicit","url":"classes/_internal_.DeezerTrack.html#explicit","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":234,"kind":1024,"name":"previewURL","url":"classes/_internal_.DeezerTrack.html#previewURL","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":235,"kind":1024,"name":"artist","url":"classes/_internal_.DeezerTrack.html#artist","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":236,"kind":1024,"name":"album","url":"classes/_internal_.DeezerTrack.html#album","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":237,"kind":1024,"name":"type","url":"classes/_internal_.DeezerTrack.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":238,"kind":1024,"name":"partial","url":"classes/_internal_.DeezerTrack.html#partial","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":239,"kind":1024,"name":"trackPosition","url":"classes/_internal_.DeezerTrack.html#trackPosition","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":240,"kind":1024,"name":"diskNumber","url":"classes/_internal_.DeezerTrack.html#diskNumber","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":241,"kind":1024,"name":"releaseDate","url":"classes/_internal_.DeezerTrack.html#releaseDate","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":242,"kind":1024,"name":"bpm","url":"classes/_internal_.DeezerTrack.html#bpm","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":243,"kind":1024,"name":"gain","url":"classes/_internal_.DeezerTrack.html#gain","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":244,"kind":1024,"name":"contributors","url":"classes/_internal_.DeezerTrack.html#contributors","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrack"},{"id":245,"kind":2048,"name":"fetch","url":"classes/_internal_.DeezerTrack.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":".DeezerTrack"},{"id":246,"kind":2048,"name":"toJSON","url":"classes/_internal_.DeezerTrack.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".DeezerTrack"},{"id":247,"kind":128,"name":"DeezerPlaylist","url":"classes/_internal_.DeezerPlaylist.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":248,"kind":512,"name":"constructor","url":"classes/_internal_.DeezerPlaylist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":249,"kind":1024,"name":"id","url":"classes/_internal_.DeezerPlaylist.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":250,"kind":1024,"name":"title","url":"classes/_internal_.DeezerPlaylist.html#title","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":251,"kind":1024,"name":"public","url":"classes/_internal_.DeezerPlaylist.html#public","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":252,"kind":1024,"name":"url","url":"classes/_internal_.DeezerPlaylist.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":253,"kind":1024,"name":"picture","url":"classes/_internal_.DeezerPlaylist.html#picture","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":254,"kind":1024,"name":"creationDate","url":"classes/_internal_.DeezerPlaylist.html#creationDate","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":255,"kind":1024,"name":"type","url":"classes/_internal_.DeezerPlaylist.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":256,"kind":1024,"name":"creator","url":"classes/_internal_.DeezerPlaylist.html#creator","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":257,"kind":1024,"name":"tracksCount","url":"classes/_internal_.DeezerPlaylist.html#tracksCount","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":258,"kind":1024,"name":"partial","url":"classes/_internal_.DeezerPlaylist.html#partial","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":259,"kind":1024,"name":"description","url":"classes/_internal_.DeezerPlaylist.html#description","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":260,"kind":1024,"name":"durationInSec","url":"classes/_internal_.DeezerPlaylist.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":261,"kind":1024,"name":"isLoved","url":"classes/_internal_.DeezerPlaylist.html#isLoved","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":262,"kind":1024,"name":"collaborative","url":"classes/_internal_.DeezerPlaylist.html#collaborative","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":263,"kind":1024,"name":"fans","url":"classes/_internal_.DeezerPlaylist.html#fans","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":264,"kind":1024,"name":"tracks","url":"classes/_internal_.DeezerPlaylist.html#tracks","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":265,"kind":2048,"name":"fetch","url":"classes/_internal_.DeezerPlaylist.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":266,"kind":2048,"name":"toJSON","url":"classes/_internal_.DeezerPlaylist.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".DeezerPlaylist"},{"id":267,"kind":128,"name":"DeezerAlbum","url":"classes/_internal_.DeezerAlbum.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":268,"kind":512,"name":"constructor","url":"classes/_internal_.DeezerAlbum.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":269,"kind":1024,"name":"id","url":"classes/_internal_.DeezerAlbum.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":270,"kind":1024,"name":"title","url":"classes/_internal_.DeezerAlbum.html#title","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":271,"kind":1024,"name":"url","url":"classes/_internal_.DeezerAlbum.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":272,"kind":1024,"name":"recordType","url":"classes/_internal_.DeezerAlbum.html#recordType","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":273,"kind":1024,"name":"explicit","url":"classes/_internal_.DeezerAlbum.html#explicit","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":274,"kind":1024,"name":"artist","url":"classes/_internal_.DeezerAlbum.html#artist","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":275,"kind":1024,"name":"cover","url":"classes/_internal_.DeezerAlbum.html#cover","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":276,"kind":1024,"name":"type","url":"classes/_internal_.DeezerAlbum.html#type","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":277,"kind":1024,"name":"tracksCount","url":"classes/_internal_.DeezerAlbum.html#tracksCount","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":278,"kind":1024,"name":"partial","url":"classes/_internal_.DeezerAlbum.html#partial","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":279,"kind":1024,"name":"upc","url":"classes/_internal_.DeezerAlbum.html#upc","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":280,"kind":1024,"name":"durationInSec","url":"classes/_internal_.DeezerAlbum.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":281,"kind":1024,"name":"numberOfFans","url":"classes/_internal_.DeezerAlbum.html#numberOfFans","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":282,"kind":1024,"name":"releaseDate","url":"classes/_internal_.DeezerAlbum.html#releaseDate","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":283,"kind":1024,"name":"available","url":"classes/_internal_.DeezerAlbum.html#available","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":284,"kind":1024,"name":"genres","url":"classes/_internal_.DeezerAlbum.html#genres","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":285,"kind":1024,"name":"contributors","url":"classes/_internal_.DeezerAlbum.html#contributors","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":286,"kind":1024,"name":"tracks","url":"classes/_internal_.DeezerAlbum.html#tracks","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":287,"kind":2048,"name":"fetch","url":"classes/_internal_.DeezerAlbum.html#fetch","classes":"tsd-kind-method tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":288,"kind":2048,"name":"toJSON","url":"classes/_internal_.DeezerAlbum.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".DeezerAlbum"},{"id":289,"kind":256,"name":"InfoData","url":"interfaces/_internal_.InfoData.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":290,"kind":1024,"name":"LiveStreamData","url":"interfaces/_internal_.InfoData.html#LiveStreamData","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".InfoData"},{"id":291,"kind":1024,"name":"html5player","url":"interfaces/_internal_.InfoData.html#html5player","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".InfoData"},{"id":292,"kind":1024,"name":"format","url":"interfaces/_internal_.InfoData.html#format","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".InfoData"},{"id":293,"kind":1024,"name":"video_details","url":"interfaces/_internal_.InfoData.html#video_details","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".InfoData"},{"id":294,"kind":1024,"name":"related_videos","url":"interfaces/_internal_.InfoData.html#related_videos","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".InfoData"},{"id":295,"kind":8,"name":"StreamType","url":"enums/_internal_.StreamType.html","classes":"tsd-kind-enum tsd-parent-kind-namespace","parent":""},{"id":296,"kind":16,"name":"Arbitrary","url":"enums/_internal_.StreamType.html#Arbitrary","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":".StreamType"},{"id":297,"kind":16,"name":"Raw","url":"enums/_internal_.StreamType.html#Raw","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":".StreamType"},{"id":298,"kind":16,"name":"OggOpus","url":"enums/_internal_.StreamType.html#OggOpus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":".StreamType"},{"id":299,"kind":16,"name":"WebmOpus","url":"enums/_internal_.StreamType.html#WebmOpus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":".StreamType"},{"id":300,"kind":16,"name":"Opus","url":"enums/_internal_.StreamType.html#Opus","classes":"tsd-kind-enum-member tsd-parent-kind-enum","parent":".StreamType"},{"id":301,"kind":128,"name":"Timer","url":"classes/_internal_.Timer.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":302,"kind":512,"name":"constructor","url":"classes/_internal_.Timer.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".Timer"},{"id":303,"kind":1024,"name":"destroyed","url":"classes/_internal_.Timer.html#destroyed","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Timer"},{"id":304,"kind":1024,"name":"paused","url":"classes/_internal_.Timer.html#paused","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Timer"},{"id":305,"kind":1024,"name":"timer","url":"classes/_internal_.Timer.html#timer","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Timer"},{"id":306,"kind":1024,"name":"callback","url":"classes/_internal_.Timer.html#callback","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Timer"},{"id":307,"kind":65536,"name":"__type","url":"classes/_internal_.Timer.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-class","parent":".Timer"},{"id":308,"kind":1024,"name":"time_start","url":"classes/_internal_.Timer.html#time_start","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Timer"},{"id":309,"kind":1024,"name":"time_left","url":"classes/_internal_.Timer.html#time_left","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Timer"},{"id":310,"kind":1024,"name":"time_total","url":"classes/_internal_.Timer.html#time_total","classes":"tsd-kind-property tsd-parent-kind-class tsd-is-private","parent":".Timer"},{"id":311,"kind":2048,"name":"pause","url":"classes/_internal_.Timer.html#pause","classes":"tsd-kind-method tsd-parent-kind-class","parent":".Timer"},{"id":312,"kind":2048,"name":"resume","url":"classes/_internal_.Timer.html#resume","classes":"tsd-kind-method tsd-parent-kind-class","parent":".Timer"},{"id":313,"kind":2048,"name":"reuse","url":"classes/_internal_.Timer.html#reuse","classes":"tsd-kind-method tsd-parent-kind-class","parent":".Timer"},{"id":314,"kind":2048,"name":"destroy","url":"classes/_internal_.Timer.html#destroy","classes":"tsd-kind-method tsd-parent-kind-class","parent":".Timer"},{"id":315,"kind":256,"name":"StreamOptions","url":"interfaces/_internal_.StreamOptions.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":316,"kind":1024,"name":"quality","url":"interfaces/_internal_.StreamOptions.html#quality","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".StreamOptions"},{"id":317,"kind":1024,"name":"proxy","url":"interfaces/_internal_.StreamOptions.html#proxy","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".StreamOptions"},{"id":318,"kind":1024,"name":"htmldata","url":"interfaces/_internal_.StreamOptions.html#htmldata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".StreamOptions"},{"id":319,"kind":256,"name":"SearchOptions","url":"interfaces/_internal_.SearchOptions.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":320,"kind":1024,"name":"limit","url":"interfaces/_internal_.SearchOptions.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SearchOptions"},{"id":321,"kind":1024,"name":"source","url":"interfaces/_internal_.SearchOptions.html#source","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SearchOptions"},{"id":322,"kind":65536,"name":"__type","url":"interfaces/_internal_.SearchOptions.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":".SearchOptions"},{"id":323,"kind":1024,"name":"youtube","url":"interfaces/_internal_.SearchOptions.html#__type.youtube","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".SearchOptions.__type"},{"id":324,"kind":1024,"name":"spotify","url":"interfaces/_internal_.SearchOptions.html#__type.spotify","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".SearchOptions.__type"},{"id":325,"kind":1024,"name":"soundcloud","url":"interfaces/_internal_.SearchOptions.html#__type.soundcloud","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".SearchOptions.__type"},{"id":326,"kind":1024,"name":"deezer","url":"interfaces/_internal_.SearchOptions.html#__type.deezer","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".SearchOptions.__type"},{"id":327,"kind":1024,"name":"fuzzy","url":"interfaces/_internal_.SearchOptions.html#fuzzy","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SearchOptions"},{"id":328,"kind":256,"name":"PlaylistOptions","url":"interfaces/_internal_.PlaylistOptions.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":329,"kind":1024,"name":"incomplete","url":"interfaces/_internal_.PlaylistOptions.html#incomplete","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistOptions"},{"id":330,"kind":1024,"name":"proxy","url":"interfaces/_internal_.PlaylistOptions.html#proxy","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistOptions"},{"id":331,"kind":256,"name":"InfoOptions","url":"interfaces/_internal_.InfoOptions.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":332,"kind":1024,"name":"proxy","url":"interfaces/_internal_.InfoOptions.html#proxy","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".InfoOptions"},{"id":333,"kind":1024,"name":"htmldata","url":"interfaces/_internal_.InfoOptions.html#htmldata","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".InfoOptions"},{"id":334,"kind":256,"name":"DeezerAdvancedSearchOptions","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":335,"kind":1024,"name":"limit","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#limit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":336,"kind":1024,"name":"artist","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#artist","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":337,"kind":1024,"name":"album","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#album","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":338,"kind":1024,"name":"title","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":339,"kind":1024,"name":"label","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#label","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":340,"kind":1024,"name":"minDurationInSec","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#minDurationInSec","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":341,"kind":1024,"name":"maxDurationInSec","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#maxDurationInSec","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":342,"kind":1024,"name":"minBPM","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#minBPM","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":343,"kind":1024,"name":"maxBPM","url":"interfaces/_internal_.DeezerAdvancedSearchOptions.html#maxBPM","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerAdvancedSearchOptions"},{"id":344,"kind":256,"name":"tokenOptions","url":"interfaces/_internal_.tokenOptions.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":345,"kind":1024,"name":"spotify","url":"interfaces/_internal_.tokenOptions.html#spotify","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".tokenOptions"},{"id":346,"kind":65536,"name":"__type","url":"interfaces/_internal_.tokenOptions.html#__type-1","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":".tokenOptions"},{"id":347,"kind":1024,"name":"client_id","url":"interfaces/_internal_.tokenOptions.html#__type-1.client_id-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".tokenOptions.__type"},{"id":348,"kind":1024,"name":"client_secret","url":"interfaces/_internal_.tokenOptions.html#__type-1.client_secret","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".tokenOptions.__type"},{"id":349,"kind":1024,"name":"refresh_token","url":"interfaces/_internal_.tokenOptions.html#__type-1.refresh_token","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".tokenOptions.__type"},{"id":350,"kind":1024,"name":"market","url":"interfaces/_internal_.tokenOptions.html#__type-1.market","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".tokenOptions.__type"},{"id":351,"kind":1024,"name":"soundcloud","url":"interfaces/_internal_.tokenOptions.html#soundcloud","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".tokenOptions"},{"id":352,"kind":65536,"name":"__type","url":"interfaces/_internal_.tokenOptions.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":".tokenOptions"},{"id":353,"kind":1024,"name":"client_id","url":"interfaces/_internal_.tokenOptions.html#__type.client_id","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".tokenOptions.__type"},{"id":354,"kind":1024,"name":"youtube","url":"interfaces/_internal_.tokenOptions.html#youtube","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".tokenOptions"},{"id":355,"kind":65536,"name":"__type","url":"interfaces/_internal_.tokenOptions.html#__type-2","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":".tokenOptions"},{"id":356,"kind":1024,"name":"cookie","url":"interfaces/_internal_.tokenOptions.html#__type-2.cookie","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".tokenOptions.__type"},{"id":357,"kind":128,"name":"YouTubeThumbnail","url":"classes/_internal_.YouTubeThumbnail.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":358,"kind":512,"name":"constructor","url":"classes/_internal_.YouTubeThumbnail.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".YouTubeThumbnail"},{"id":359,"kind":1024,"name":"id","url":"classes/_internal_.YouTubeThumbnail.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeThumbnail"},{"id":360,"kind":1024,"name":"url","url":"classes/_internal_.YouTubeThumbnail.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeThumbnail"},{"id":361,"kind":1024,"name":"width","url":"classes/_internal_.YouTubeThumbnail.html#width","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeThumbnail"},{"id":362,"kind":1024,"name":"height","url":"classes/_internal_.YouTubeThumbnail.html#height","classes":"tsd-kind-property tsd-parent-kind-class","parent":".YouTubeThumbnail"},{"id":363,"kind":2048,"name":"toJSON","url":"classes/_internal_.YouTubeThumbnail.html#toJSON","classes":"tsd-kind-method tsd-parent-kind-class","parent":".YouTubeThumbnail"},{"id":364,"kind":256,"name":"ChannelIconInterface","url":"interfaces/_internal_.ChannelIconInterface.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":365,"kind":1024,"name":"url","url":"interfaces/_internal_.ChannelIconInterface.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelIconInterface"},{"id":366,"kind":1024,"name":"width","url":"interfaces/_internal_.ChannelIconInterface.html#width","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelIconInterface"},{"id":367,"kind":1024,"name":"height","url":"interfaces/_internal_.ChannelIconInterface.html#height","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelIconInterface"},{"id":368,"kind":4194304,"name":"ProxyOptions","url":"modules/_internal_.html#ProxyOptions","classes":"tsd-kind-type-alias tsd-parent-kind-namespace","parent":""},{"id":369,"kind":256,"name":"SpotifyThumbnail","url":"interfaces/_internal_.SpotifyThumbnail.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":370,"kind":1024,"name":"height","url":"interfaces/_internal_.SpotifyThumbnail.html#height","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyThumbnail"},{"id":371,"kind":1024,"name":"width","url":"interfaces/_internal_.SpotifyThumbnail.html#width","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyThumbnail"},{"id":372,"kind":1024,"name":"url","url":"interfaces/_internal_.SpotifyThumbnail.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyThumbnail"},{"id":373,"kind":256,"name":"SpotifyArtists","url":"interfaces/_internal_.SpotifyArtists.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":374,"kind":1024,"name":"name","url":"interfaces/_internal_.SpotifyArtists.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyArtists"},{"id":375,"kind":1024,"name":"url","url":"interfaces/_internal_.SpotifyArtists.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyArtists"},{"id":376,"kind":1024,"name":"id","url":"interfaces/_internal_.SpotifyArtists.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyArtists"},{"id":377,"kind":256,"name":"SpotifyCopyright","url":"interfaces/_internal_.SpotifyCopyright.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":378,"kind":1024,"name":"text","url":"interfaces/_internal_.SpotifyCopyright.html#text","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyCopyright"},{"id":379,"kind":1024,"name":"type","url":"interfaces/_internal_.SpotifyCopyright.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyCopyright"},{"id":380,"kind":256,"name":"SpotifyDataOptions","url":"interfaces/_internal_.SpotifyDataOptions.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":381,"kind":1024,"name":"client_id","url":"interfaces/_internal_.SpotifyDataOptions.html#client_id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":382,"kind":1024,"name":"client_secret","url":"interfaces/_internal_.SpotifyDataOptions.html#client_secret","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":383,"kind":1024,"name":"redirect_url","url":"interfaces/_internal_.SpotifyDataOptions.html#redirect_url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":384,"kind":1024,"name":"authorization_code","url":"interfaces/_internal_.SpotifyDataOptions.html#authorization_code","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":385,"kind":1024,"name":"access_token","url":"interfaces/_internal_.SpotifyDataOptions.html#access_token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":386,"kind":1024,"name":"refresh_token","url":"interfaces/_internal_.SpotifyDataOptions.html#refresh_token","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":387,"kind":1024,"name":"token_type","url":"interfaces/_internal_.SpotifyDataOptions.html#token_type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":388,"kind":1024,"name":"expires_in","url":"interfaces/_internal_.SpotifyDataOptions.html#expires_in","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":389,"kind":1024,"name":"expiry","url":"interfaces/_internal_.SpotifyDataOptions.html#expiry","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":390,"kind":1024,"name":"market","url":"interfaces/_internal_.SpotifyDataOptions.html#market","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":391,"kind":1024,"name":"file","url":"interfaces/_internal_.SpotifyDataOptions.html#file","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyDataOptions"},{"id":392,"kind":256,"name":"SpotifyTrackAlbum","url":"interfaces/_internal_.SpotifyTrackAlbum.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":393,"kind":1024,"name":"name","url":"interfaces/_internal_.SpotifyTrackAlbum.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyTrackAlbum"},{"id":394,"kind":1024,"name":"url","url":"interfaces/_internal_.SpotifyTrackAlbum.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyTrackAlbum"},{"id":395,"kind":1024,"name":"id","url":"interfaces/_internal_.SpotifyTrackAlbum.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyTrackAlbum"},{"id":396,"kind":1024,"name":"release_date","url":"interfaces/_internal_.SpotifyTrackAlbum.html#release_date","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyTrackAlbum"},{"id":397,"kind":1024,"name":"release_date_precision","url":"interfaces/_internal_.SpotifyTrackAlbum.html#release_date_precision","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyTrackAlbum"},{"id":398,"kind":1024,"name":"total_tracks","url":"interfaces/_internal_.SpotifyTrackAlbum.html#total_tracks","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SpotifyTrackAlbum"},{"id":399,"kind":256,"name":"SoundCloudTrackFormat","url":"interfaces/_internal_.SoundCloudTrackFormat.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":400,"kind":1024,"name":"url","url":"interfaces/_internal_.SoundCloudTrackFormat.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudTrackFormat"},{"id":401,"kind":1024,"name":"preset","url":"interfaces/_internal_.SoundCloudTrackFormat.html#preset","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudTrackFormat"},{"id":402,"kind":1024,"name":"duration","url":"interfaces/_internal_.SoundCloudTrackFormat.html#duration","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudTrackFormat"},{"id":403,"kind":1024,"name":"format","url":"interfaces/_internal_.SoundCloudTrackFormat.html#format","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudTrackFormat"},{"id":404,"kind":65536,"name":"__type","url":"interfaces/_internal_.SoundCloudTrackFormat.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":".SoundCloudTrackFormat"},{"id":405,"kind":1024,"name":"protocol","url":"interfaces/_internal_.SoundCloudTrackFormat.html#__type.protocol","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".SoundCloudTrackFormat.__type"},{"id":406,"kind":1024,"name":"mime_type","url":"interfaces/_internal_.SoundCloudTrackFormat.html#__type.mime_type","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".SoundCloudTrackFormat.__type"},{"id":407,"kind":1024,"name":"quality","url":"interfaces/_internal_.SoundCloudTrackFormat.html#quality","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudTrackFormat"},{"id":408,"kind":256,"name":"SoundCloudUser","url":"interfaces/_internal_.SoundCloudUser.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":409,"kind":1024,"name":"name","url":"interfaces/_internal_.SoundCloudUser.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":410,"kind":1024,"name":"id","url":"interfaces/_internal_.SoundCloudUser.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":411,"kind":1024,"name":"url","url":"interfaces/_internal_.SoundCloudUser.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":412,"kind":1024,"name":"type","url":"interfaces/_internal_.SoundCloudUser.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":413,"kind":1024,"name":"verified","url":"interfaces/_internal_.SoundCloudUser.html#verified","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":414,"kind":1024,"name":"description","url":"interfaces/_internal_.SoundCloudUser.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":415,"kind":1024,"name":"first_name","url":"interfaces/_internal_.SoundCloudUser.html#first_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":416,"kind":1024,"name":"full_name","url":"interfaces/_internal_.SoundCloudUser.html#full_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":417,"kind":1024,"name":"last_name","url":"interfaces/_internal_.SoundCloudUser.html#last_name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":418,"kind":1024,"name":"thumbnail","url":"interfaces/_internal_.SoundCloudUser.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudUser"},{"id":419,"kind":256,"name":"SoundCloudTrackDeprecated","url":"interfaces/_internal_.SoundCloudTrackDeprecated.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":420,"kind":1024,"name":"fetched","url":"interfaces/_internal_.SoundCloudTrackDeprecated.html#fetched","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudTrackDeprecated"},{"id":421,"kind":1024,"name":"id","url":"interfaces/_internal_.SoundCloudTrackDeprecated.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudTrackDeprecated"},{"id":422,"kind":1024,"name":"type","url":"interfaces/_internal_.SoundCloudTrackDeprecated.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundCloudTrackDeprecated"},{"id":423,"kind":128,"name":"DeezerArtist","url":"classes/_internal_.DeezerArtist.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":424,"kind":512,"name":"constructor","url":"classes/_internal_.DeezerArtist.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".DeezerArtist"},{"id":425,"kind":1024,"name":"id","url":"classes/_internal_.DeezerArtist.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerArtist"},{"id":426,"kind":1024,"name":"name","url":"classes/_internal_.DeezerArtist.html#name","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerArtist"},{"id":427,"kind":1024,"name":"url","url":"classes/_internal_.DeezerArtist.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerArtist"},{"id":428,"kind":1024,"name":"picture","url":"classes/_internal_.DeezerArtist.html#picture","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerArtist"},{"id":429,"kind":1024,"name":"role","url":"classes/_internal_.DeezerArtist.html#role","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerArtist"},{"id":430,"kind":128,"name":"DeezerTrackAlbum","url":"classes/_internal_.DeezerTrackAlbum.html","classes":"tsd-kind-class tsd-parent-kind-namespace","parent":""},{"id":431,"kind":512,"name":"constructor","url":"classes/_internal_.DeezerTrackAlbum.html#constructor","classes":"tsd-kind-constructor tsd-parent-kind-class","parent":".DeezerTrackAlbum"},{"id":432,"kind":1024,"name":"id","url":"classes/_internal_.DeezerTrackAlbum.html#id","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrackAlbum"},{"id":433,"kind":1024,"name":"title","url":"classes/_internal_.DeezerTrackAlbum.html#title","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrackAlbum"},{"id":434,"kind":1024,"name":"url","url":"classes/_internal_.DeezerTrackAlbum.html#url","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrackAlbum"},{"id":435,"kind":1024,"name":"cover","url":"classes/_internal_.DeezerTrackAlbum.html#cover","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrackAlbum"},{"id":436,"kind":1024,"name":"releaseDate","url":"classes/_internal_.DeezerTrackAlbum.html#releaseDate","classes":"tsd-kind-property tsd-parent-kind-class","parent":".DeezerTrackAlbum"},{"id":437,"kind":256,"name":"DeezerImage","url":"interfaces/_internal_.DeezerImage.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":438,"kind":1024,"name":"xl","url":"interfaces/_internal_.DeezerImage.html#xl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerImage"},{"id":439,"kind":1024,"name":"big","url":"interfaces/_internal_.DeezerImage.html#big","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerImage"},{"id":440,"kind":1024,"name":"medium","url":"interfaces/_internal_.DeezerImage.html#medium","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerImage"},{"id":441,"kind":1024,"name":"small","url":"interfaces/_internal_.DeezerImage.html#small","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerImage"},{"id":442,"kind":256,"name":"DeezerUser","url":"interfaces/_internal_.DeezerUser.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":443,"kind":1024,"name":"id","url":"interfaces/_internal_.DeezerUser.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerUser"},{"id":444,"kind":1024,"name":"name","url":"interfaces/_internal_.DeezerUser.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerUser"},{"id":445,"kind":256,"name":"DeezerGenre","url":"interfaces/_internal_.DeezerGenre.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":446,"kind":1024,"name":"name","url":"interfaces/_internal_.DeezerGenre.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerGenre"},{"id":447,"kind":1024,"name":"picture","url":"interfaces/_internal_.DeezerGenre.html#picture","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".DeezerGenre"},{"id":448,"kind":256,"name":"LiveStreamData","url":"interfaces/_internal_.LiveStreamData.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":449,"kind":1024,"name":"isLive","url":"interfaces/_internal_.LiveStreamData.html#isLive","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".LiveStreamData"},{"id":450,"kind":1024,"name":"dashManifestUrl","url":"interfaces/_internal_.LiveStreamData.html#dashManifestUrl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".LiveStreamData"},{"id":451,"kind":1024,"name":"hlsManifestUrl","url":"interfaces/_internal_.LiveStreamData.html#hlsManifestUrl","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".LiveStreamData"},{"id":452,"kind":256,"name":"formatData","url":"interfaces/_internal_.formatData.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":453,"kind":1024,"name":"itag","url":"interfaces/_internal_.formatData.html#itag","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":454,"kind":1024,"name":"mimeType","url":"interfaces/_internal_.formatData.html#mimeType","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":455,"kind":1024,"name":"bitrate","url":"interfaces/_internal_.formatData.html#bitrate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":456,"kind":1024,"name":"width","url":"interfaces/_internal_.formatData.html#width","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":457,"kind":1024,"name":"height","url":"interfaces/_internal_.formatData.html#height","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":458,"kind":1024,"name":"lastModified","url":"interfaces/_internal_.formatData.html#lastModified","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":459,"kind":1024,"name":"contentLength","url":"interfaces/_internal_.formatData.html#contentLength","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":460,"kind":1024,"name":"quality","url":"interfaces/_internal_.formatData.html#quality","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":461,"kind":1024,"name":"fps","url":"interfaces/_internal_.formatData.html#fps","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":462,"kind":1024,"name":"qualityLabel","url":"interfaces/_internal_.formatData.html#qualityLabel","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":463,"kind":1024,"name":"projectionType","url":"interfaces/_internal_.formatData.html#projectionType","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":464,"kind":1024,"name":"averageBitrate","url":"interfaces/_internal_.formatData.html#averageBitrate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":465,"kind":1024,"name":"audioQuality","url":"interfaces/_internal_.formatData.html#audioQuality","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":466,"kind":1024,"name":"approxDurationMs","url":"interfaces/_internal_.formatData.html#approxDurationMs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":467,"kind":1024,"name":"audioSampleRate","url":"interfaces/_internal_.formatData.html#audioSampleRate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":468,"kind":1024,"name":"audioChannels","url":"interfaces/_internal_.formatData.html#audioChannels","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":469,"kind":1024,"name":"url","url":"interfaces/_internal_.formatData.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":470,"kind":1024,"name":"signatureCipher","url":"interfaces/_internal_.formatData.html#signatureCipher","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":471,"kind":1024,"name":"cipher","url":"interfaces/_internal_.formatData.html#cipher","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":472,"kind":1024,"name":"loudnessDb","url":"interfaces/_internal_.formatData.html#loudnessDb","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":473,"kind":1024,"name":"targetDurationSec","url":"interfaces/_internal_.formatData.html#targetDurationSec","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".formatData"},{"id":474,"kind":256,"name":"VideoOptions","url":"interfaces/_internal_.VideoOptions.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":475,"kind":1024,"name":"id","url":"interfaces/_internal_.VideoOptions.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":476,"kind":1024,"name":"url","url":"interfaces/_internal_.VideoOptions.html#url-1","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":477,"kind":1024,"name":"title","url":"interfaces/_internal_.VideoOptions.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":478,"kind":1024,"name":"description","url":"interfaces/_internal_.VideoOptions.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":479,"kind":1024,"name":"durationRaw","url":"interfaces/_internal_.VideoOptions.html#durationRaw","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":480,"kind":1024,"name":"durationInSec","url":"interfaces/_internal_.VideoOptions.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":481,"kind":1024,"name":"uploadedAt","url":"interfaces/_internal_.VideoOptions.html#uploadedAt","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":482,"kind":1024,"name":"views","url":"interfaces/_internal_.VideoOptions.html#views","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":483,"kind":1024,"name":"thumbnail","url":"interfaces/_internal_.VideoOptions.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":484,"kind":65536,"name":"__type","url":"interfaces/_internal_.VideoOptions.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":".VideoOptions"},{"id":485,"kind":1024,"name":"id","url":"interfaces/_internal_.VideoOptions.html#__type.id-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".VideoOptions.__type"},{"id":486,"kind":1024,"name":"width","url":"interfaces/_internal_.VideoOptions.html#__type.width","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".VideoOptions.__type"},{"id":487,"kind":1024,"name":"height","url":"interfaces/_internal_.VideoOptions.html#__type.height","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".VideoOptions.__type"},{"id":488,"kind":1024,"name":"url","url":"interfaces/_internal_.VideoOptions.html#__type.url","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".VideoOptions.__type"},{"id":489,"kind":1024,"name":"channel","url":"interfaces/_internal_.VideoOptions.html#channel","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":490,"kind":1024,"name":"likes","url":"interfaces/_internal_.VideoOptions.html#likes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":491,"kind":1024,"name":"dislikes","url":"interfaces/_internal_.VideoOptions.html#dislikes","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":492,"kind":1024,"name":"live","url":"interfaces/_internal_.VideoOptions.html#live","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":493,"kind":1024,"name":"private","url":"interfaces/_internal_.VideoOptions.html#private","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":494,"kind":1024,"name":"tags","url":"interfaces/_internal_.VideoOptions.html#tags","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".VideoOptions"},{"id":495,"kind":256,"name":"ChannelJSON","url":"interfaces/_internal_.ChannelJSON.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":496,"kind":1024,"name":"name","url":"interfaces/_internal_.ChannelJSON.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelJSON"},{"id":497,"kind":1024,"name":"verified","url":"interfaces/_internal_.ChannelJSON.html#verified","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelJSON"},{"id":498,"kind":1024,"name":"artist","url":"interfaces/_internal_.ChannelJSON.html#artist","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelJSON"},{"id":499,"kind":1024,"name":"id","url":"interfaces/_internal_.ChannelJSON.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelJSON"},{"id":500,"kind":1024,"name":"type","url":"interfaces/_internal_.ChannelJSON.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelJSON"},{"id":501,"kind":1024,"name":"url","url":"interfaces/_internal_.ChannelJSON.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelJSON"},{"id":502,"kind":1024,"name":"icon","url":"interfaces/_internal_.ChannelJSON.html#icon","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelJSON"},{"id":503,"kind":1024,"name":"subscribers","url":"interfaces/_internal_.ChannelJSON.html#subscribers","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ChannelJSON"},{"id":504,"kind":256,"name":"PlaylistJSON","url":"interfaces/_internal_.PlaylistJSON.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":505,"kind":1024,"name":"id","url":"interfaces/_internal_.PlaylistJSON.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":506,"kind":1024,"name":"title","url":"interfaces/_internal_.PlaylistJSON.html#title","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":507,"kind":1024,"name":"videoCount","url":"interfaces/_internal_.PlaylistJSON.html#videoCount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":508,"kind":1024,"name":"lastUpdate","url":"interfaces/_internal_.PlaylistJSON.html#lastUpdate","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":509,"kind":1024,"name":"views","url":"interfaces/_internal_.PlaylistJSON.html#views","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":510,"kind":1024,"name":"url","url":"interfaces/_internal_.PlaylistJSON.html#url-1","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":511,"kind":1024,"name":"link","url":"interfaces/_internal_.PlaylistJSON.html#link","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":512,"kind":1024,"name":"channel","url":"interfaces/_internal_.PlaylistJSON.html#channel","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":513,"kind":1024,"name":"thumbnail","url":"interfaces/_internal_.PlaylistJSON.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":514,"kind":65536,"name":"__type","url":"interfaces/_internal_.PlaylistJSON.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":515,"kind":1024,"name":"id","url":"interfaces/_internal_.PlaylistJSON.html#__type.id-1","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".PlaylistJSON.__type"},{"id":516,"kind":1024,"name":"width","url":"interfaces/_internal_.PlaylistJSON.html#__type.width","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".PlaylistJSON.__type"},{"id":517,"kind":1024,"name":"height","url":"interfaces/_internal_.PlaylistJSON.html#__type.height","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".PlaylistJSON.__type"},{"id":518,"kind":1024,"name":"url","url":"interfaces/_internal_.PlaylistJSON.html#__type.url","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".PlaylistJSON.__type"},{"id":519,"kind":1024,"name":"videos","url":"interfaces/_internal_.PlaylistJSON.html#videos","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":520,"kind":256,"name":"AlbumJSON","url":"interfaces/_internal_.AlbumJSON.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":521,"kind":1024,"name":"name","url":"interfaces/_internal_.AlbumJSON.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":522,"kind":1024,"name":"type","url":"interfaces/_internal_.AlbumJSON.html#type","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":523,"kind":1024,"name":"url","url":"interfaces/_internal_.AlbumJSON.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":524,"kind":1024,"name":"id","url":"interfaces/_internal_.AlbumJSON.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":525,"kind":1024,"name":"thumbnail","url":"interfaces/_internal_.AlbumJSON.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":526,"kind":1024,"name":"artists","url":"interfaces/_internal_.AlbumJSON.html#artists","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":527,"kind":1024,"name":"copyrights","url":"interfaces/_internal_.AlbumJSON.html#copyrights","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":528,"kind":1024,"name":"release_date","url":"interfaces/_internal_.AlbumJSON.html#release_date","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":529,"kind":1024,"name":"release_date_precision","url":"interfaces/_internal_.AlbumJSON.html#release_date_precision","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":530,"kind":1024,"name":"tracksCount","url":"interfaces/_internal_.AlbumJSON.html#tracksCount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".AlbumJSON"},{"id":531,"kind":256,"name":"PlaylistJSON","url":"interfaces/_internal_.PlaylistJSON-1.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":532,"kind":1024,"name":"name","url":"interfaces/_internal_.PlaylistJSON-1.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":533,"kind":1024,"name":"collaborative","url":"interfaces/_internal_.PlaylistJSON-1.html#collaborative","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":534,"kind":1024,"name":"description","url":"interfaces/_internal_.PlaylistJSON-1.html#description","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":535,"kind":1024,"name":"url","url":"interfaces/_internal_.PlaylistJSON-1.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":536,"kind":1024,"name":"id","url":"interfaces/_internal_.PlaylistJSON-1.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":537,"kind":1024,"name":"thumbnail","url":"interfaces/_internal_.PlaylistJSON-1.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":538,"kind":1024,"name":"owner","url":"interfaces/_internal_.PlaylistJSON-1.html#owner","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":539,"kind":1024,"name":"tracksCount","url":"interfaces/_internal_.PlaylistJSON-1.html#tracksCount","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".PlaylistJSON"},{"id":540,"kind":256,"name":"TrackJSON","url":"interfaces/_internal_.TrackJSON.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":541,"kind":1024,"name":"name","url":"interfaces/_internal_.TrackJSON.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":542,"kind":1024,"name":"id","url":"interfaces/_internal_.TrackJSON.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":543,"kind":1024,"name":"url","url":"interfaces/_internal_.TrackJSON.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":544,"kind":1024,"name":"explicit","url":"interfaces/_internal_.TrackJSON.html#explicit","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":545,"kind":1024,"name":"durationInSec","url":"interfaces/_internal_.TrackJSON.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":546,"kind":1024,"name":"durationInMs","url":"interfaces/_internal_.TrackJSON.html#durationInMs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":547,"kind":1024,"name":"artists","url":"interfaces/_internal_.TrackJSON.html#artists","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":548,"kind":1024,"name":"album","url":"interfaces/_internal_.TrackJSON.html#album","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":549,"kind":1024,"name":"thumbnail","url":"interfaces/_internal_.TrackJSON.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".TrackJSON"},{"id":550,"kind":256,"name":"SoundTrackJSON","url":"interfaces/_internal_.SoundTrackJSON.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":551,"kind":1024,"name":"name","url":"interfaces/_internal_.SoundTrackJSON.html#name","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":552,"kind":1024,"name":"id","url":"interfaces/_internal_.SoundTrackJSON.html#id","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":553,"kind":1024,"name":"url","url":"interfaces/_internal_.SoundTrackJSON.html#url","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":554,"kind":1024,"name":"fetched","url":"interfaces/_internal_.SoundTrackJSON.html#fetched","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":555,"kind":1024,"name":"durationInSec","url":"interfaces/_internal_.SoundTrackJSON.html#durationInSec","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":556,"kind":1024,"name":"durationInMs","url":"interfaces/_internal_.SoundTrackJSON.html#durationInMs","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":557,"kind":1024,"name":"formats","url":"interfaces/_internal_.SoundTrackJSON.html#formats","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":558,"kind":1024,"name":"publisher","url":"interfaces/_internal_.SoundTrackJSON.html#publisher","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":559,"kind":1024,"name":"thumbnail","url":"interfaces/_internal_.SoundTrackJSON.html#thumbnail","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":560,"kind":1024,"name":"user","url":"interfaces/_internal_.SoundTrackJSON.html#user","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".SoundTrackJSON"},{"id":561,"kind":256,"name":"ProxyOpts","url":"interfaces/_internal_.ProxyOpts.html","classes":"tsd-kind-interface tsd-parent-kind-namespace","parent":""},{"id":562,"kind":1024,"name":"host","url":"interfaces/_internal_.ProxyOpts.html#host","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ProxyOpts"},{"id":563,"kind":1024,"name":"port","url":"interfaces/_internal_.ProxyOpts.html#port","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ProxyOpts"},{"id":564,"kind":1024,"name":"authentication","url":"interfaces/_internal_.ProxyOpts.html#authentication","classes":"tsd-kind-property tsd-parent-kind-interface","parent":".ProxyOpts"},{"id":565,"kind":65536,"name":"__type","url":"interfaces/_internal_.ProxyOpts.html#__type","classes":"tsd-kind-type-literal tsd-parent-kind-interface","parent":".ProxyOpts"},{"id":566,"kind":1024,"name":"username","url":"interfaces/_internal_.ProxyOpts.html#__type.username","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".ProxyOpts.__type"},{"id":567,"kind":1024,"name":"password","url":"interfaces/_internal_.ProxyOpts.html#__type.password","classes":"tsd-kind-property tsd-parent-kind-type-literal","parent":".ProxyOpts.__type"}],"index":{"version":"2.3.9","fields":["name","parent"],"fieldVectors":[["name/0",[0,46.391]],["parent/0",[]],["name/1",[1,59.384]],["parent/1",[]],["name/2",[2,59.384]],["parent/2",[]],["name/3",[3,59.384]],["parent/3",[]],["name/4",[4,59.384]],["parent/4",[]],["name/5",[5,59.384]],["parent/5",[]],["name/6",[6,59.384]],["parent/6",[]],["name/7",[7,59.384]],["parent/7",[]],["name/8",[8,59.384]],["parent/8",[]],["name/9",[9,59.384]],["parent/9",[]],["name/10",[10,59.384]],["parent/10",[]],["name/11",[11,59.384]],["parent/11",[]],["name/12",[12,50.911]],["parent/12",[]],["name/13",[13,59.384]],["parent/13",[]],["name/14",[14,59.384]],["parent/14",[]],["name/15",[15,48.398]],["parent/15",[]],["name/16",[16,59.384]],["parent/16",[]],["name/17",[17,59.384]],["parent/17",[]],["name/18",[18,59.384]],["parent/18",[]],["name/19",[15,48.398]],["parent/19",[]],["name/20",[19,48.398]],["parent/20",[]],["name/21",[20,59.384]],["parent/21",[]],["name/22",[19,48.398]],["parent/22",[]],["name/23",[21,34.817]],["parent/23",[]],["name/24",[22,34.261]],["parent/24",[21,3.401]],["name/25",[0,46.391]],["parent/25",[21,3.401]],["name/26",[23,33.735]],["parent/26",[21,3.401]],["name/27",[24,28.323]],["parent/27",[21,3.401]],["name/28",[25,59.384]],["parent/28",[21,3.401]],["name/29",[26,46.391]],["parent/29",[21,3.401]],["name/30",[27,59.384]],["parent/30",[21,3.401]],["name/31",[28,50.911]],["parent/31",[21,3.401]],["name/32",[29,59.384]],["parent/32",[21,3.401]],["name/33",[30,59.384]],["parent/33",[21,3.401]],["name/34",[31,59.384]],["parent/34",[21,3.401]],["name/35",[32,54.276]],["parent/35",[21,3.401]],["name/36",[33,54.276]],["parent/36",[21,3.401]],["name/37",[34,50.911]],["parent/37",[21,3.401]],["name/38",[35,48.398]],["parent/38",[21,3.401]],["name/39",[36,48.398]],["parent/39",[21,3.401]],["name/40",[37,59.384]],["parent/40",[]],["name/41",[38,50.911]],["parent/41",[]],["name/42",[39,59.384]],["parent/42",[]],["name/43",[40,59.384]],["parent/43",[]],["name/44",[38,50.911]],["parent/44",[]],["name/45",[41,59.384]],["parent/45",[]],["name/46",[42,24.419]],["parent/46",[]],["name/47",[43,59.384]],["parent/47",[42,2.386]],["name/48",[22,34.261]],["parent/48",[44,3.296]],["name/49",[45,29.94]],["parent/49",[44,3.296]],["name/50",[24,28.323]],["parent/50",[44,3.296]],["name/51",[23,33.735]],["parent/51",[44,3.296]],["name/52",[46,40.926]],["parent/52",[44,3.296]],["name/53",[47,44.721]],["parent/53",[44,3.296]],["name/54",[48,54.276]],["parent/54",[44,3.296]],["name/55",[49,39.925]],["parent/55",[44,3.296]],["name/56",[50,54.276]],["parent/56",[44,3.296]],["name/57",[51,48.398]],["parent/57",[44,3.296]],["name/58",[52,37.412]],["parent/58",[44,3.296]],["name/59",[53,48.398]],["parent/59",[44,3.296]],["name/60",[54,54.276]],["parent/60",[44,3.296]],["name/61",[55,54.276]],["parent/61",[44,3.296]],["name/62",[56,54.276]],["parent/62",[44,3.296]],["name/63",[57,54.276]],["parent/63",[44,3.296]],["name/64",[58,54.276]],["parent/64",[44,3.296]],["name/65",[59,54.276]],["parent/65",[44,3.296]],["name/66",[60,38.182]],["parent/66",[44,3.296]],["name/67",[61,59.384]],["parent/67",[42,2.386]],["name/68",[22,34.261]],["parent/68",[62,3.73]],["name/69",[63,34.817]],["parent/69",[62,3.73]],["name/70",[64,50.911]],["parent/70",[62,3.73]],["name/71",[65,46.391]],["parent/71",[62,3.73]],["name/72",[45,29.94]],["parent/72",[62,3.73]],["name/73",[23,33.735]],["parent/73",[62,3.73]],["name/74",[24,28.323]],["parent/74",[62,3.73]],["name/75",[66,54.276]],["parent/75",[62,3.73]],["name/76",[67,54.276]],["parent/76",[62,3.73]],["name/77",[68,59.384]],["parent/77",[62,3.73]],["name/78",[59,54.276]],["parent/78",[62,3.73]],["name/79",[60,38.182]],["parent/79",[62,3.73]],["name/80",[69,59.384]],["parent/80",[42,2.386]],["name/81",[22,34.261]],["parent/81",[70,3.073]],["name/82",[45,29.94]],["parent/82",[70,3.073]],["name/83",[46,40.926]],["parent/83",[70,3.073]],["name/84",[23,33.735]],["parent/84",[70,3.073]],["name/85",[71,54.276]],["parent/85",[70,3.073]],["name/86",[72,54.276]],["parent/86",[70,3.073]],["name/87",[51,48.398]],["parent/87",[70,3.073]],["name/88",[24,28.323]],["parent/88",[70,3.073]],["name/89",[73,54.276]],["parent/89",[70,3.073]],["name/90",[53,48.398]],["parent/90",[70,3.073]],["name/91",[52,37.412]],["parent/91",[70,3.073]],["name/92",[74,54.276]],["parent/92",[70,3.073]],["name/93",[75,59.384]],["parent/93",[70,3.073]],["name/94",[76,59.384]],["parent/94",[70,3.073]],["name/95",[77,39.925]],["parent/95",[70,3.073]],["name/96",[78,59.384]],["parent/96",[79,4.974]],["name/97",[80,59.384]],["parent/97",[79,4.974]],["name/98",[81,59.384]],["parent/98",[79,4.974]],["name/99",[82,59.384]],["parent/99",[70,3.073]],["name/100",[83,59.384]],["parent/100",[70,3.073]],["name/101",[84,59.384]],["parent/101",[70,3.073]],["name/102",[85,59.384]],["parent/102",[70,3.073]],["name/103",[86,43.29]],["parent/103",[70,3.073]],["name/104",[87,50.911]],["parent/104",[70,3.073]],["name/105",[88,50.911]],["parent/105",[70,3.073]],["name/106",[89,59.384]],["parent/106",[70,3.073]],["name/107",[60,38.182]],["parent/107",[70,3.073]],["name/108",[0,46.391]],["parent/108",[42,2.386]],["name/109",[22,34.261]],["parent/109",[90,3.401]],["name/110",[0,46.391]],["parent/110",[90,3.401]],["name/111",[23,33.735]],["parent/111",[90,3.401]],["name/112",[24,28.323]],["parent/112",[90,3.401]],["name/113",[91,59.384]],["parent/113",[90,3.401]],["name/114",[92,59.384]],["parent/114",[90,3.401]],["name/115",[93,59.384]],["parent/115",[90,3.401]],["name/116",[94,54.276]],["parent/116",[90,3.401]],["name/117",[26,46.391]],["parent/117",[90,3.401]],["name/118",[95,48.398]],["parent/118",[90,3.401]],["name/119",[96,48.398]],["parent/119",[90,3.401]],["name/120",[28,50.911]],["parent/120",[90,3.401]],["name/121",[97,59.384]],["parent/121",[90,3.401]],["name/122",[34,50.911]],["parent/122",[90,3.401]],["name/123",[33,54.276]],["parent/123",[90,3.401]],["name/124",[35,48.398]],["parent/124",[90,3.401]],["name/125",[36,48.398]],["parent/125",[90,3.401]],["name/126",[98,59.384]],["parent/126",[42,2.386]],["name/127",[22,34.261]],["parent/127",[99,3.347]],["name/128",[0,46.391]],["parent/128",[99,3.347]],["name/129",[23,33.735]],["parent/129",[99,3.347]],["name/130",[100,59.384]],["parent/130",[99,3.347]],["name/131",[24,28.323]],["parent/131",[99,3.347]],["name/132",[101,59.384]],["parent/132",[99,3.347]],["name/133",[102,59.384]],["parent/133",[99,3.347]],["name/134",[26,46.391]],["parent/134",[99,3.347]],["name/135",[94,54.276]],["parent/135",[99,3.347]],["name/136",[103,59.384]],["parent/136",[99,3.347]],["name/137",[104,59.384]],["parent/137",[99,3.347]],["name/138",[28,50.911]],["parent/138",[99,3.347]],["name/139",[105,59.384]],["parent/139",[99,3.347]],["name/140",[106,59.384]],["parent/140",[99,3.347]],["name/141",[34,50.911]],["parent/141",[99,3.347]],["name/142",[32,54.276]],["parent/142",[99,3.347]],["name/143",[35,48.398]],["parent/143",[99,3.347]],["name/144",[36,48.398]],["parent/144",[99,3.347]],["name/145",[107,59.384]],["parent/145",[42,2.386]],["name/146",[22,34.261]],["parent/146",[108,3.347]],["name/147",[63,34.817]],["parent/147",[108,3.347]],["name/148",[23,33.735]],["parent/148",[108,3.347]],["name/149",[24,28.323]],["parent/149",[108,3.347]],["name/150",[45,29.94]],["parent/150",[108,3.347]],["name/151",[52,37.412]],["parent/151",[108,3.347]],["name/152",[109,48.398]],["parent/152",[108,3.347]],["name/153",[110,54.276]],["parent/153",[108,3.347]],["name/154",[111,50.911]],["parent/154",[108,3.347]],["name/155",[112,50.911]],["parent/155",[108,3.347]],["name/156",[113,43.29]],["parent/156",[108,3.347]],["name/157",[114,54.276]],["parent/157",[108,3.347]],["name/158",[115,54.276]],["parent/158",[108,3.347]],["name/159",[86,43.29]],["parent/159",[108,3.347]],["name/160",[87,50.911]],["parent/160",[108,3.347]],["name/161",[88,50.911]],["parent/161",[108,3.347]],["name/162",[116,48.398]],["parent/162",[108,3.347]],["name/163",[60,38.182]],["parent/163",[108,3.347]],["name/164",[117,59.384]],["parent/164",[42,2.386]],["name/165",[22,34.261]],["parent/165",[118,3.401]],["name/166",[63,34.817]],["parent/166",[118,3.401]],["name/167",[23,33.735]],["parent/167",[118,3.401]],["name/168",[119,50.911]],["parent/168",[118,3.401]],["name/169",[47,44.721]],["parent/169",[118,3.401]],["name/170",[24,28.323]],["parent/170",[118,3.401]],["name/171",[45,29.94]],["parent/171",[118,3.401]],["name/172",[52,37.412]],["parent/172",[118,3.401]],["name/173",[120,54.276]],["parent/173",[118,3.401]],["name/174",[113,43.29]],["parent/174",[118,3.401]],["name/175",[114,54.276]],["parent/175",[118,3.401]],["name/176",[115,54.276]],["parent/176",[118,3.401]],["name/177",[86,43.29]],["parent/177",[118,3.401]],["name/178",[87,50.911]],["parent/178",[118,3.401]],["name/179",[88,50.911]],["parent/179",[118,3.401]],["name/180",[116,48.398]],["parent/180",[118,3.401]],["name/181",[60,38.182]],["parent/181",[118,3.401]],["name/182",[121,59.384]],["parent/182",[42,2.386]],["name/183",[22,34.261]],["parent/183",[122,3.73]],["name/184",[63,34.817]],["parent/184",[122,3.73]],["name/185",[23,33.735]],["parent/185",[122,3.73]],["name/186",[45,29.94]],["parent/186",[122,3.73]],["name/187",[24,28.323]],["parent/187",[122,3.73]],["name/188",[123,48.398]],["parent/188",[122,3.73]],["name/189",[49,39.925]],["parent/189",[122,3.73]],["name/190",[124,46.391]],["parent/190",[122,3.73]],["name/191",[109,48.398]],["parent/191",[122,3.73]],["name/192",[125,48.398]],["parent/192",[122,3.73]],["name/193",[52,37.412]],["parent/193",[122,3.73]],["name/194",[60,38.182]],["parent/194",[122,3.73]],["name/195",[126,59.384]],["parent/195",[42,2.386]],["name/196",[22,34.261]],["parent/196",[127,3.655]],["name/197",[63,34.817]],["parent/197",[127,3.655]],["name/198",[45,29.94]],["parent/198",[127,3.655]],["name/199",[24,28.323]],["parent/199",[127,3.655]],["name/200",[128,50.911]],["parent/200",[127,3.655]],["name/201",[23,33.735]],["parent/201",[127,3.655]],["name/202",[49,39.925]],["parent/202",[127,3.655]],["name/203",[124,46.391]],["parent/203",[127,3.655]],["name/204",[129,54.276]],["parent/204",[127,3.655]],["name/205",[130,54.276]],["parent/205",[127,3.655]],["name/206",[52,37.412]],["parent/206",[127,3.655]],["name/207",[131,50.911]],["parent/207",[127,3.655]],["name/208",[60,38.182]],["parent/208",[127,3.655]],["name/209",[132,59.384]],["parent/209",[42,2.386]],["name/210",[22,34.261]],["parent/210",[133,3.52]],["name/211",[63,34.817]],["parent/211",[133,3.52]],["name/212",[45,29.94]],["parent/212",[133,3.52]],["name/213",[24,28.323]],["parent/213",[133,3.52]],["name/214",[23,33.735]],["parent/214",[133,3.52]],["name/215",[134,59.384]],["parent/215",[133,3.52]],["name/216",[49,39.925]],["parent/216",[133,3.52]],["name/217",[124,46.391]],["parent/217",[133,3.52]],["name/218",[135,48.398]],["parent/218",[133,3.52]],["name/219",[131,50.911]],["parent/219",[133,3.52]],["name/220",[136,50.911]],["parent/220",[133,3.52]],["name/221",[113,43.29]],["parent/221",[133,3.52]],["name/222",[86,43.29]],["parent/222",[133,3.52]],["name/223",[116,48.398]],["parent/223",[133,3.52]],["name/224",[60,38.182]],["parent/224",[133,3.52]],["name/225",[137,59.384]],["parent/225",[42,2.386]],["name/226",[22,34.261]],["parent/226",[138,3.2]],["name/227",[45,29.94]],["parent/227",[138,3.2]],["name/228",[46,40.926]],["parent/228",[138,3.2]],["name/229",[139,59.384]],["parent/229",[138,3.2]],["name/230",[24,28.323]],["parent/230",[138,3.2]],["name/231",[49,39.925]],["parent/231",[138,3.2]],["name/232",[140,59.384]],["parent/232",[138,3.2]],["name/233",[123,48.398]],["parent/233",[138,3.2]],["name/234",[141,59.384]],["parent/234",[138,3.2]],["name/235",[65,46.391]],["parent/235",[138,3.2]],["name/236",[125,48.398]],["parent/236",[138,3.2]],["name/237",[23,33.735]],["parent/237",[138,3.2]],["name/238",[142,50.911]],["parent/238",[138,3.2]],["name/239",[143,59.384]],["parent/239",[138,3.2]],["name/240",[144,59.384]],["parent/240",[138,3.2]],["name/241",[145,50.911]],["parent/241",[138,3.2]],["name/242",[146,59.384]],["parent/242",[138,3.2]],["name/243",[147,59.384]],["parent/243",[138,3.2]],["name/244",[148,54.276]],["parent/244",[138,3.2]],["name/245",[86,43.29]],["parent/245",[138,3.2]],["name/246",[60,38.182]],["parent/246",[138,3.2]],["name/247",[149,59.384]],["parent/247",[42,2.386]],["name/248",[22,34.261]],["parent/248",[150,3.296]],["name/249",[45,29.94]],["parent/249",[150,3.296]],["name/250",[46,40.926]],["parent/250",[150,3.296]],["name/251",[151,59.384]],["parent/251",[150,3.296]],["name/252",[24,28.323]],["parent/252",[150,3.296]],["name/253",[152,50.911]],["parent/253",[150,3.296]],["name/254",[153,59.384]],["parent/254",[150,3.296]],["name/255",[23,33.735]],["parent/255",[150,3.296]],["name/256",[154,59.384]],["parent/256",[150,3.296]],["name/257",[113,43.29]],["parent/257",[150,3.296]],["name/258",[142,50.911]],["parent/258",[150,3.296]],["name/259",[47,44.721]],["parent/259",[150,3.296]],["name/260",[49,39.925]],["parent/260",[150,3.296]],["name/261",[155,59.384]],["parent/261",[150,3.296]],["name/262",[119,50.911]],["parent/262",[150,3.296]],["name/263",[156,59.384]],["parent/263",[150,3.296]],["name/264",[136,50.911]],["parent/264",[150,3.296]],["name/265",[86,43.29]],["parent/265",[150,3.296]],["name/266",[60,38.182]],["parent/266",[150,3.296]],["name/267",[157,59.384]],["parent/267",[42,2.386]],["name/268",[22,34.261]],["parent/268",[158,3.2]],["name/269",[45,29.94]],["parent/269",[158,3.2]],["name/270",[46,40.926]],["parent/270",[158,3.2]],["name/271",[24,28.323]],["parent/271",[158,3.2]],["name/272",[159,59.384]],["parent/272",[158,3.2]],["name/273",[123,48.398]],["parent/273",[158,3.2]],["name/274",[65,46.391]],["parent/274",[158,3.2]],["name/275",[160,54.276]],["parent/275",[158,3.2]],["name/276",[23,33.735]],["parent/276",[158,3.2]],["name/277",[113,43.29]],["parent/277",[158,3.2]],["name/278",[142,50.911]],["parent/278",[158,3.2]],["name/279",[161,59.384]],["parent/279",[158,3.2]],["name/280",[49,39.925]],["parent/280",[158,3.2]],["name/281",[162,59.384]],["parent/281",[158,3.2]],["name/282",[145,50.911]],["parent/282",[158,3.2]],["name/283",[163,59.384]],["parent/283",[158,3.2]],["name/284",[164,59.384]],["parent/284",[158,3.2]],["name/285",[148,54.276]],["parent/285",[158,3.2]],["name/286",[136,50.911]],["parent/286",[158,3.2]],["name/287",[86,43.29]],["parent/287",[158,3.2]],["name/288",[60,38.182]],["parent/288",[158,3.2]],["name/289",[165,59.384]],["parent/289",[42,2.386]],["name/290",[166,54.276]],["parent/290",[167,4.532]],["name/291",[168,59.384]],["parent/291",[167,4.532]],["name/292",[169,54.276]],["parent/292",[167,4.532]],["name/293",[170,59.384]],["parent/293",[167,4.532]],["name/294",[171,59.384]],["parent/294",[167,4.532]],["name/295",[172,59.384]],["parent/295",[42,2.386]],["name/296",[173,59.384]],["parent/296",[174,4.532]],["name/297",[175,59.384]],["parent/297",[174,4.532]],["name/298",[176,59.384]],["parent/298",[174,4.532]],["name/299",[177,59.384]],["parent/299",[174,4.532]],["name/300",[178,59.384]],["parent/300",[174,4.532]],["name/301",[26,46.391]],["parent/301",[42,2.386]],["name/302",[22,34.261]],["parent/302",[179,3.655]],["name/303",[180,59.384]],["parent/303",[179,3.655]],["name/304",[181,59.384]],["parent/304",[179,3.655]],["name/305",[26,46.391]],["parent/305",[179,3.655]],["name/306",[182,59.384]],["parent/306",[179,3.655]],["name/307",[77,39.925]],["parent/307",[179,3.655]],["name/308",[183,59.384]],["parent/308",[179,3.655]],["name/309",[184,59.384]],["parent/309",[179,3.655]],["name/310",[185,59.384]],["parent/310",[179,3.655]],["name/311",[35,48.398]],["parent/311",[179,3.655]],["name/312",[36,48.398]],["parent/312",[179,3.655]],["name/313",[186,59.384]],["parent/313",[179,3.655]],["name/314",[187,59.384]],["parent/314",[179,3.655]],["name/315",[188,59.384]],["parent/315",[42,2.386]],["name/316",[95,48.398]],["parent/316",[189,4.974]],["name/317",[96,48.398]],["parent/317",[189,4.974]],["name/318",[190,54.276]],["parent/318",[189,4.974]],["name/319",[191,59.384]],["parent/319",[42,2.386]],["name/320",[192,54.276]],["parent/320",[193,4.728]],["name/321",[194,59.384]],["parent/321",[193,4.728]],["name/322",[77,39.925]],["parent/322",[193,4.728]],["name/323",[12,50.911]],["parent/323",[195,4.728]],["name/324",[15,48.398]],["parent/324",[195,4.728]],["name/325",[19,48.398]],["parent/325",[195,4.728]],["name/326",[38,50.911]],["parent/326",[195,4.728]],["name/327",[196,59.384]],["parent/327",[193,4.728]],["name/328",[197,59.384]],["parent/328",[42,2.386]],["name/329",[198,59.384]],["parent/329",[199,5.302]],["name/330",[96,48.398]],["parent/330",[199,5.302]],["name/331",[200,59.384]],["parent/331",[42,2.386]],["name/332",[96,48.398]],["parent/332",[201,5.302]],["name/333",[190,54.276]],["parent/333",[201,5.302]],["name/334",[202,59.384]],["parent/334",[42,2.386]],["name/335",[192,54.276]],["parent/335",[203,3.998]],["name/336",[65,46.391]],["parent/336",[203,3.998]],["name/337",[125,48.398]],["parent/337",[203,3.998]],["name/338",[46,40.926]],["parent/338",[203,3.998]],["name/339",[204,59.384]],["parent/339",[203,3.998]],["name/340",[205,59.384]],["parent/340",[203,3.998]],["name/341",[206,59.384]],["parent/341",[203,3.998]],["name/342",[207,59.384]],["parent/342",[203,3.998]],["name/343",[208,59.384]],["parent/343",[203,3.998]],["name/344",[209,59.384]],["parent/344",[42,2.386]],["name/345",[15,48.398]],["parent/345",[210,4.369]],["name/346",[77,39.925]],["parent/346",[210,4.369]],["name/347",[135,48.398]],["parent/347",[211,4.369]],["name/348",[212,54.276]],["parent/348",[211,4.369]],["name/349",[213,54.276]],["parent/349",[211,4.369]],["name/350",[214,54.276]],["parent/350",[211,4.369]],["name/351",[19,48.398]],["parent/351",[210,4.369]],["name/352",[77,39.925]],["parent/352",[210,4.369]],["name/353",[135,48.398]],["parent/353",[211,4.369]],["name/354",[12,50.911]],["parent/354",[210,4.369]],["name/355",[77,39.925]],["parent/355",[210,4.369]],["name/356",[215,59.384]],["parent/356",[211,4.369]],["name/357",[216,59.384]],["parent/357",[42,2.386]],["name/358",[22,34.261]],["parent/358",[217,4.369]],["name/359",[45,29.94]],["parent/359",[217,4.369]],["name/360",[24,28.323]],["parent/360",[217,4.369]],["name/361",[218,44.721]],["parent/361",[217,4.369]],["name/362",[219,44.721]],["parent/362",[217,4.369]],["name/363",[60,38.182]],["parent/363",[217,4.369]],["name/364",[220,59.384]],["parent/364",[42,2.386]],["name/365",[24,28.323]],["parent/365",[221,4.974]],["name/366",[218,44.721]],["parent/366",[221,4.974]],["name/367",[219,44.721]],["parent/367",[221,4.974]],["name/368",[222,59.384]],["parent/368",[42,2.386]],["name/369",[223,59.384]],["parent/369",[42,2.386]],["name/370",[219,44.721]],["parent/370",[224,4.974]],["name/371",[218,44.721]],["parent/371",[224,4.974]],["name/372",[24,28.323]],["parent/372",[224,4.974]],["name/373",[225,59.384]],["parent/373",[42,2.386]],["name/374",[63,34.817]],["parent/374",[226,4.974]],["name/375",[24,28.323]],["parent/375",[226,4.974]],["name/376",[45,29.94]],["parent/376",[226,4.974]],["name/377",[227,59.384]],["parent/377",[42,2.386]],["name/378",[228,59.384]],["parent/378",[229,5.302]],["name/379",[23,33.735]],["parent/379",[229,5.302]],["name/380",[230,59.384]],["parent/380",[42,2.386]],["name/381",[135,48.398]],["parent/381",[231,3.812]],["name/382",[212,54.276]],["parent/382",[231,3.812]],["name/383",[232,59.384]],["parent/383",[231,3.812]],["name/384",[233,59.384]],["parent/384",[231,3.812]],["name/385",[234,59.384]],["parent/385",[231,3.812]],["name/386",[213,54.276]],["parent/386",[231,3.812]],["name/387",[235,59.384]],["parent/387",[231,3.812]],["name/388",[236,59.384]],["parent/388",[231,3.812]],["name/389",[237,59.384]],["parent/389",[231,3.812]],["name/390",[214,54.276]],["parent/390",[231,3.812]],["name/391",[238,59.384]],["parent/391",[231,3.812]],["name/392",[239,59.384]],["parent/392",[42,2.386]],["name/393",[63,34.817]],["parent/393",[240,4.369]],["name/394",[24,28.323]],["parent/394",[240,4.369]],["name/395",[45,29.94]],["parent/395",[240,4.369]],["name/396",[111,50.911]],["parent/396",[240,4.369]],["name/397",[112,50.911]],["parent/397",[240,4.369]],["name/398",[116,48.398]],["parent/398",[240,4.369]],["name/399",[241,59.384]],["parent/399",[42,2.386]],["name/400",[24,28.323]],["parent/400",[242,4.369]],["name/401",[243,59.384]],["parent/401",[242,4.369]],["name/402",[244,59.384]],["parent/402",[242,4.369]],["name/403",[169,54.276]],["parent/403",[242,4.369]],["name/404",[77,39.925]],["parent/404",[242,4.369]],["name/405",[245,59.384]],["parent/405",[246,5.302]],["name/406",[247,59.384]],["parent/406",[246,5.302]],["name/407",[95,48.398]],["parent/407",[242,4.369]],["name/408",[248,59.384]],["parent/408",[42,2.386]],["name/409",[63,34.817]],["parent/409",[249,3.9]],["name/410",[45,29.94]],["parent/410",[249,3.9]],["name/411",[24,28.323]],["parent/411",[249,3.9]],["name/412",[23,33.735]],["parent/412",[249,3.9]],["name/413",[64,50.911]],["parent/413",[249,3.9]],["name/414",[47,44.721]],["parent/414",[249,3.9]],["name/415",[250,59.384]],["parent/415",[249,3.9]],["name/416",[251,59.384]],["parent/416",[249,3.9]],["name/417",[252,59.384]],["parent/417",[249,3.9]],["name/418",[52,37.412]],["parent/418",[249,3.9]],["name/419",[253,59.384]],["parent/419",[42,2.386]],["name/420",[128,50.911]],["parent/420",[254,4.974]],["name/421",[45,29.94]],["parent/421",[254,4.974]],["name/422",[23,33.735]],["parent/422",[254,4.974]],["name/423",[255,59.384]],["parent/423",[42,2.386]],["name/424",[22,34.261]],["parent/424",[256,4.369]],["name/425",[45,29.94]],["parent/425",[256,4.369]],["name/426",[63,34.817]],["parent/426",[256,4.369]],["name/427",[24,28.323]],["parent/427",[256,4.369]],["name/428",[152,50.911]],["parent/428",[256,4.369]],["name/429",[257,59.384]],["parent/429",[256,4.369]],["name/430",[258,59.384]],["parent/430",[42,2.386]],["name/431",[22,34.261]],["parent/431",[259,4.369]],["name/432",[45,29.94]],["parent/432",[259,4.369]],["name/433",[46,40.926]],["parent/433",[259,4.369]],["name/434",[24,28.323]],["parent/434",[259,4.369]],["name/435",[160,54.276]],["parent/435",[259,4.369]],["name/436",[145,50.911]],["parent/436",[259,4.369]],["name/437",[260,59.384]],["parent/437",[42,2.386]],["name/438",[261,59.384]],["parent/438",[262,4.728]],["name/439",[263,59.384]],["parent/439",[262,4.728]],["name/440",[264,59.384]],["parent/440",[262,4.728]],["name/441",[265,59.384]],["parent/441",[262,4.728]],["name/442",[266,59.384]],["parent/442",[42,2.386]],["name/443",[45,29.94]],["parent/443",[267,5.302]],["name/444",[63,34.817]],["parent/444",[267,5.302]],["name/445",[268,59.384]],["parent/445",[42,2.386]],["name/446",[63,34.817]],["parent/446",[269,5.302]],["name/447",[152,50.911]],["parent/447",[269,5.302]],["name/448",[166,54.276]],["parent/448",[42,2.386]],["name/449",[270,59.384]],["parent/449",[271,4.974]],["name/450",[272,59.384]],["parent/450",[271,4.974]],["name/451",[273,59.384]],["parent/451",[271,4.974]],["name/452",[274,59.384]],["parent/452",[42,2.386]],["name/453",[275,59.384]],["parent/453",[276,3.2]],["name/454",[277,59.384]],["parent/454",[276,3.2]],["name/455",[278,59.384]],["parent/455",[276,3.2]],["name/456",[218,44.721]],["parent/456",[276,3.2]],["name/457",[219,44.721]],["parent/457",[276,3.2]],["name/458",[279,59.384]],["parent/458",[276,3.2]],["name/459",[280,59.384]],["parent/459",[276,3.2]],["name/460",[95,48.398]],["parent/460",[276,3.2]],["name/461",[281,59.384]],["parent/461",[276,3.2]],["name/462",[282,59.384]],["parent/462",[276,3.2]],["name/463",[283,59.384]],["parent/463",[276,3.2]],["name/464",[284,59.384]],["parent/464",[276,3.2]],["name/465",[285,59.384]],["parent/465",[276,3.2]],["name/466",[286,59.384]],["parent/466",[276,3.2]],["name/467",[287,59.384]],["parent/467",[276,3.2]],["name/468",[288,59.384]],["parent/468",[276,3.2]],["name/469",[24,28.323]],["parent/469",[276,3.2]],["name/470",[289,59.384]],["parent/470",[276,3.2]],["name/471",[290,59.384]],["parent/471",[276,3.2]],["name/472",[291,59.384]],["parent/472",[276,3.2]],["name/473",[292,59.384]],["parent/473",[276,3.2]],["name/474",[293,59.384]],["parent/474",[42,2.386]],["name/475",[45,29.94]],["parent/475",[294,3.459]],["name/476",[24,28.323]],["parent/476",[294,3.459]],["name/477",[46,40.926]],["parent/477",[294,3.459]],["name/478",[47,44.721]],["parent/478",[294,3.459]],["name/479",[48,54.276]],["parent/479",[294,3.459]],["name/480",[49,39.925]],["parent/480",[294,3.459]],["name/481",[50,54.276]],["parent/481",[294,3.459]],["name/482",[51,48.398]],["parent/482",[294,3.459]],["name/483",[52,37.412]],["parent/483",[294,3.459]],["name/484",[77,39.925]],["parent/484",[294,3.459]],["name/485",[45,29.94]],["parent/485",[295,4.728]],["name/486",[218,44.721]],["parent/486",[295,4.728]],["name/487",[219,44.721]],["parent/487",[295,4.728]],["name/488",[24,28.323]],["parent/488",[295,4.728]],["name/489",[53,48.398]],["parent/489",[294,3.459]],["name/490",[54,54.276]],["parent/490",[294,3.459]],["name/491",[55,54.276]],["parent/491",[294,3.459]],["name/492",[56,54.276]],["parent/492",[294,3.459]],["name/493",[57,54.276]],["parent/493",[294,3.459]],["name/494",[58,54.276]],["parent/494",[294,3.459]],["name/495",[296,59.384]],["parent/495",[42,2.386]],["name/496",[63,34.817]],["parent/496",[297,4.107]],["name/497",[64,50.911]],["parent/497",[297,4.107]],["name/498",[65,46.391]],["parent/498",[297,4.107]],["name/499",[45,29.94]],["parent/499",[297,4.107]],["name/500",[23,33.735]],["parent/500",[297,4.107]],["name/501",[24,28.323]],["parent/501",[297,4.107]],["name/502",[66,54.276]],["parent/502",[297,4.107]],["name/503",[67,54.276]],["parent/503",[297,4.107]],["name/504",[298,54.276]],["parent/504",[42,2.386]],["name/505",[45,29.94]],["parent/505",[299,3.296]],["name/506",[46,40.926]],["parent/506",[299,3.296]],["name/507",[71,54.276]],["parent/507",[299,3.296]],["name/508",[72,54.276]],["parent/508",[299,3.296]],["name/509",[51,48.398]],["parent/509",[299,3.296]],["name/510",[24,28.323]],["parent/510",[299,3.296]],["name/511",[73,54.276]],["parent/511",[299,3.296]],["name/512",[53,48.398]],["parent/512",[299,3.296]],["name/513",[52,37.412]],["parent/513",[299,3.296]],["name/514",[77,39.925]],["parent/514",[299,3.296]],["name/515",[45,29.94]],["parent/515",[300,4.728]],["name/516",[218,44.721]],["parent/516",[300,4.728]],["name/517",[219,44.721]],["parent/517",[300,4.728]],["name/518",[24,28.323]],["parent/518",[300,4.728]],["name/519",[74,54.276]],["parent/519",[299,3.296]],["name/520",[301,59.384]],["parent/520",[42,2.386]],["name/521",[63,34.817]],["parent/521",[302,3.9]],["name/522",[23,33.735]],["parent/522",[302,3.9]],["name/523",[24,28.323]],["parent/523",[302,3.9]],["name/524",[45,29.94]],["parent/524",[302,3.9]],["name/525",[52,37.412]],["parent/525",[302,3.9]],["name/526",[109,48.398]],["parent/526",[302,3.9]],["name/527",[110,54.276]],["parent/527",[302,3.9]],["name/528",[111,50.911]],["parent/528",[302,3.9]],["name/529",[112,50.911]],["parent/529",[302,3.9]],["name/530",[113,43.29]],["parent/530",[302,3.9]],["name/531",[298,54.276]],["parent/531",[42,2.386]],["name/532",[63,34.817]],["parent/532",[299,3.296]],["name/533",[119,50.911]],["parent/533",[299,3.296]],["name/534",[47,44.721]],["parent/534",[299,3.296]],["name/535",[24,28.323]],["parent/535",[299,3.296]],["name/536",[45,29.94]],["parent/536",[299,3.296]],["name/537",[52,37.412]],["parent/537",[299,3.296]],["name/538",[120,54.276]],["parent/538",[299,3.296]],["name/539",[113,43.29]],["parent/539",[299,3.296]],["name/540",[303,59.384]],["parent/540",[42,2.386]],["name/541",[63,34.817]],["parent/541",[304,3.998]],["name/542",[45,29.94]],["parent/542",[304,3.998]],["name/543",[24,28.323]],["parent/543",[304,3.998]],["name/544",[123,48.398]],["parent/544",[304,3.998]],["name/545",[49,39.925]],["parent/545",[304,3.998]],["name/546",[124,46.391]],["parent/546",[304,3.998]],["name/547",[109,48.398]],["parent/547",[304,3.998]],["name/548",[125,48.398]],["parent/548",[304,3.998]],["name/549",[52,37.412]],["parent/549",[304,3.998]],["name/550",[305,59.384]],["parent/550",[42,2.386]],["name/551",[63,34.817]],["parent/551",[306,3.9]],["name/552",[45,29.94]],["parent/552",[306,3.9]],["name/553",[24,28.323]],["parent/553",[306,3.9]],["name/554",[128,50.911]],["parent/554",[306,3.9]],["name/555",[49,39.925]],["parent/555",[306,3.9]],["name/556",[124,46.391]],["parent/556",[306,3.9]],["name/557",[129,54.276]],["parent/557",[306,3.9]],["name/558",[130,54.276]],["parent/558",[306,3.9]],["name/559",[52,37.412]],["parent/559",[306,3.9]],["name/560",[131,50.911]],["parent/560",[306,3.9]],["name/561",[307,59.384]],["parent/561",[42,2.386]],["name/562",[308,59.384]],["parent/562",[309,4.728]],["name/563",[310,59.384]],["parent/563",[309,4.728]],["name/564",[311,59.384]],["parent/564",[309,4.728]],["name/565",[77,39.925]],["parent/565",[309,4.728]],["name/566",[312,59.384]],["parent/566",[313,5.302]],["name/567",[314,59.384]],["parent/567",[313,5.302]]],"invertedIndex":[["__count",{"_index":82,"name":{"99":{}},"parent":{}}],["__patch",{"_index":83,"name":{"100":{}},"parent":{}}],["__patchsearch",{"_index":84,"name":{"101":{}},"parent":{}}],["__type",{"_index":77,"name":{"95":{},"307":{},"322":{},"346":{},"352":{},"355":{},"404":{},"484":{},"514":{},"565":{}},"parent":{}}],["_continuation",{"_index":76,"name":{"94":{}},"parent":{}}],["access_token",{"_index":234,"name":{"385":{}},"parent":{}}],["album",{"_index":125,"name":{"192":{},"236":{},"337":{},"548":{}},"parent":{}}],["albumjson",{"_index":301,"name":{"520":{}},"parent":{}}],["api",{"_index":78,"name":{"96":{}},"parent":{}}],["approxdurationms",{"_index":286,"name":{"466":{}},"parent":{}}],["arbitrary",{"_index":173,"name":{"296":{}},"parent":{}}],["artist",{"_index":65,"name":{"71":{},"235":{},"274":{},"336":{},"498":{}},"parent":{}}],["artists",{"_index":109,"name":{"152":{},"191":{},"526":{},"547":{}},"parent":{}}],["attachlisteners",{"_index":5,"name":{"5":{}},"parent":{}}],["audiochannels",{"_index":288,"name":{"468":{}},"parent":{}}],["audioquality",{"_index":285,"name":{"465":{}},"parent":{}}],["audiosamplerate",{"_index":287,"name":{"467":{}},"parent":{}}],["authentication",{"_index":311,"name":{"564":{}},"parent":{}}],["authorization",{"_index":4,"name":{"4":{}},"parent":{}}],["authorization_code",{"_index":233,"name":{"384":{}},"parent":{}}],["available",{"_index":163,"name":{"283":{}},"parent":{}}],["averagebitrate",{"_index":284,"name":{"464":{}},"parent":{}}],["base_url",{"_index":100,"name":{"130":{}},"parent":{}}],["big",{"_index":263,"name":{"439":{}},"parent":{}}],["bitrate",{"_index":278,"name":{"455":{}},"parent":{}}],["bpm",{"_index":146,"name":{"242":{}},"parent":{}}],["bytes_count",{"_index":91,"name":{"113":{}},"parent":{}}],["callback",{"_index":182,"name":{"306":{}},"parent":{}}],["channel",{"_index":53,"name":{"59":{},"90":{},"489":{},"512":{}},"parent":{}}],["channeliconinterface",{"_index":220,"name":{"364":{}},"parent":{}}],["channeljson",{"_index":296,"name":{"495":{}},"parent":{}}],["cipher",{"_index":290,"name":{"471":{}},"parent":{}}],["cleanup",{"_index":34,"name":{"37":{},"122":{},"141":{}},"parent":{}}],["client_id",{"_index":135,"name":{"218":{},"347":{},"353":{},"381":{}},"parent":{}}],["client_secret",{"_index":212,"name":{"348":{},"382":{}},"parent":{}}],["clientversion",{"_index":81,"name":{"98":{}},"parent":{}}],["collaborative",{"_index":119,"name":{"168":{},"262":{},"533":{}},"parent":{}}],["constructor",{"_index":22,"name":{"24":{},"48":{},"68":{},"81":{},"109":{},"127":{},"146":{},"165":{},"183":{},"196":{},"210":{},"226":{},"248":{},"268":{},"302":{},"358":{},"424":{},"431":{}},"parent":{}}],["content_length",{"_index":93,"name":{"115":{}},"parent":{}}],["contentlength",{"_index":280,"name":{"459":{}},"parent":{}}],["contributors",{"_index":148,"name":{"244":{},"285":{}},"parent":{}}],["cookie",{"_index":215,"name":{"356":{}},"parent":{}}],["cookieheaders",{"_index":14,"name":{"14":{}},"parent":{}}],["copyrights",{"_index":110,"name":{"153":{},"527":{}},"parent":{}}],["cover",{"_index":160,"name":{"275":{},"435":{}},"parent":{}}],["creationdate",{"_index":153,"name":{"254":{}},"parent":{}}],["creator",{"_index":154,"name":{"256":{}},"parent":{}}],["dash_getter",{"_index":106,"name":{"140":{}},"parent":{}}],["dash_timer",{"_index":103,"name":{"136":{}},"parent":{}}],["dash_updater",{"_index":105,"name":{"139":{}},"parent":{}}],["dashmanifesturl",{"_index":272,"name":{"450":{}},"parent":{}}],["decipher_info",{"_index":9,"name":{"9":{}},"parent":{}}],["deezer",{"_index":38,"name":{"41":{},"44":{},"326":{}},"parent":{}}],["deezeradvancedsearchoptions",{"_index":202,"name":{"334":{}},"parent":{}}],["deezeralbum",{"_index":157,"name":{"267":{}},"parent":{}}],["deezerartist",{"_index":255,"name":{"423":{}},"parent":{}}],["deezergenre",{"_index":268,"name":{"445":{}},"parent":{}}],["deezerimage",{"_index":260,"name":{"437":{}},"parent":{}}],["deezerplaylist",{"_index":149,"name":{"247":{}},"parent":{}}],["deezertrack",{"_index":137,"name":{"225":{}},"parent":{}}],["deezertrackalbum",{"_index":258,"name":{"430":{}},"parent":{}}],["deezeruser",{"_index":266,"name":{"442":{}},"parent":{}}],["description",{"_index":47,"name":{"53":{},"169":{},"259":{},"414":{},"478":{},"534":{}},"parent":{}}],["destroy",{"_index":187,"name":{"314":{}},"parent":{}}],["destroyed",{"_index":180,"name":{"303":{}},"parent":{}}],["disknumber",{"_index":144,"name":{"240":{}},"parent":{}}],["dislikes",{"_index":55,"name":{"61":{},"491":{}},"parent":{}}],["downloaded_segments",{"_index":27,"name":{"30":{}},"parent":{}}],["downloaded_time",{"_index":25,"name":{"28":{}},"parent":{}}],["duration",{"_index":244,"name":{"402":{}},"parent":{}}],["durationinms",{"_index":124,"name":{"190":{},"203":{},"217":{},"546":{},"556":{}},"parent":{}}],["durationinsec",{"_index":49,"name":{"55":{},"189":{},"202":{},"216":{},"231":{},"260":{},"280":{},"480":{},"545":{},"555":{}},"parent":{}}],["durationraw",{"_index":48,"name":{"54":{},"479":{}},"parent":{}}],["dz_advanced_track_search",{"_index":40,"name":{"43":{}},"parent":{}}],["dz_validate",{"_index":39,"name":{"42":{}},"parent":{}}],["expires_in",{"_index":236,"name":{"388":{}},"parent":{}}],["expiry",{"_index":237,"name":{"389":{}},"parent":{}}],["explicit",{"_index":123,"name":{"188":{},"233":{},"273":{},"544":{}},"parent":{}}],["extractid",{"_index":11,"name":{"11":{}},"parent":{}}],["fans",{"_index":156,"name":{"263":{}},"parent":{}}],["fetch",{"_index":86,"name":{"103":{},"159":{},"177":{},"222":{},"245":{},"265":{},"287":{}},"parent":{}}],["fetched",{"_index":128,"name":{"200":{},"420":{},"554":{}},"parent":{}}],["fetched_tracks",{"_index":115,"name":{"158":{},"176":{}},"parent":{}}],["fetched_videos",{"_index":75,"name":{"93":{}},"parent":{}}],["file",{"_index":238,"name":{"391":{}},"parent":{}}],["first_name",{"_index":250,"name":{"415":{}},"parent":{}}],["format",{"_index":169,"name":{"292":{},"403":{}},"parent":{}}],["formatdata",{"_index":274,"name":{"452":{}},"parent":{}}],["formats",{"_index":129,"name":{"204":{},"557":{}},"parent":{}}],["fps",{"_index":281,"name":{"461":{}},"parent":{}}],["full_name",{"_index":251,"name":{"416":{}},"parent":{}}],["fuzzy",{"_index":196,"name":{"327":{}},"parent":{}}],["gain",{"_index":147,"name":{"243":{}},"parent":{}}],["genres",{"_index":164,"name":{"284":{}},"parent":{}}],["getfreeclientid",{"_index":37,"name":{"40":{}},"parent":{}}],["height",{"_index":219,"name":{"362":{},"367":{},"370":{},"457":{},"487":{},"517":{}},"parent":{}}],["hlsmanifesturl",{"_index":273,"name":{"451":{}},"parent":{}}],["host",{"_index":308,"name":{"562":{}},"parent":{}}],["html5player",{"_index":168,"name":{"291":{}},"parent":{}}],["htmldata",{"_index":190,"name":{"318":{},"333":{}},"parent":{}}],["icon",{"_index":66,"name":{"75":{},"502":{}},"parent":{}}],["iconurl",{"_index":68,"name":{"77":{}},"parent":{}}],["id",{"_index":45,"name":{"49":{},"72":{},"82":{},"150":{},"171":{},"186":{},"198":{},"212":{},"227":{},"249":{},"269":{},"359":{},"376":{},"395":{},"410":{},"421":{},"425":{},"432":{},"443":{},"475":{},"485":{},"499":{},"505":{},"515":{},"524":{},"536":{},"542":{},"552":{}},"parent":{}}],["incomplete",{"_index":198,"name":{"329":{}},"parent":{}}],["infodata",{"_index":165,"name":{"289":{}},"parent":{}}],["infooptions",{"_index":200,"name":{"331":{}},"parent":{}}],["internal",{"_index":42,"name":{"46":{}},"parent":{"47":{},"67":{},"80":{},"108":{},"126":{},"145":{},"164":{},"182":{},"195":{},"209":{},"225":{},"247":{},"267":{},"289":{},"295":{},"301":{},"315":{},"319":{},"328":{},"331":{},"334":{},"344":{},"357":{},"364":{},"368":{},"369":{},"373":{},"377":{},"380":{},"392":{},"399":{},"408":{},"419":{},"423":{},"430":{},"437":{},"442":{},"445":{},"448":{},"452":{},"474":{},"495":{},"504":{},"520":{},"531":{},"540":{},"550":{},"561":{}}}],["internal>.albumjson",{"_index":302,"name":{},"parent":{"521":{},"522":{},"523":{},"524":{},"525":{},"526":{},"527":{},"528":{},"529":{},"530":{}}}],["internal>.channeliconinterface",{"_index":221,"name":{},"parent":{"365":{},"366":{},"367":{}}}],["internal>.channeljson",{"_index":297,"name":{},"parent":{"496":{},"497":{},"498":{},"499":{},"500":{},"501":{},"502":{},"503":{}}}],["internal>.deezeradvancedsearchoptions",{"_index":203,"name":{},"parent":{"335":{},"336":{},"337":{},"338":{},"339":{},"340":{},"341":{},"342":{},"343":{}}}],["internal>.deezeralbum",{"_index":158,"name":{},"parent":{"268":{},"269":{},"270":{},"271":{},"272":{},"273":{},"274":{},"275":{},"276":{},"277":{},"278":{},"279":{},"280":{},"281":{},"282":{},"283":{},"284":{},"285":{},"286":{},"287":{},"288":{}}}],["internal>.deezerartist",{"_index":256,"name":{},"parent":{"424":{},"425":{},"426":{},"427":{},"428":{},"429":{}}}],["internal>.deezergenre",{"_index":269,"name":{},"parent":{"446":{},"447":{}}}],["internal>.deezerimage",{"_index":262,"name":{},"parent":{"438":{},"439":{},"440":{},"441":{}}}],["internal>.deezerplaylist",{"_index":150,"name":{},"parent":{"248":{},"249":{},"250":{},"251":{},"252":{},"253":{},"254":{},"255":{},"256":{},"257":{},"258":{},"259":{},"260":{},"261":{},"262":{},"263":{},"264":{},"265":{},"266":{}}}],["internal>.deezertrack",{"_index":138,"name":{},"parent":{"226":{},"227":{},"228":{},"229":{},"230":{},"231":{},"232":{},"233":{},"234":{},"235":{},"236":{},"237":{},"238":{},"239":{},"240":{},"241":{},"242":{},"243":{},"244":{},"245":{},"246":{}}}],["internal>.deezertrackalbum",{"_index":259,"name":{},"parent":{"431":{},"432":{},"433":{},"434":{},"435":{},"436":{}}}],["internal>.deezeruser",{"_index":267,"name":{},"parent":{"443":{},"444":{}}}],["internal>.formatdata",{"_index":276,"name":{},"parent":{"453":{},"454":{},"455":{},"456":{},"457":{},"458":{},"459":{},"460":{},"461":{},"462":{},"463":{},"464":{},"465":{},"466":{},"467":{},"468":{},"469":{},"470":{},"471":{},"472":{},"473":{}}}],["internal>.infodata",{"_index":167,"name":{},"parent":{"290":{},"291":{},"292":{},"293":{},"294":{}}}],["internal>.infooptions",{"_index":201,"name":{},"parent":{"332":{},"333":{}}}],["internal>.livestream",{"_index":99,"name":{},"parent":{"127":{},"128":{},"129":{},"130":{},"131":{},"132":{},"133":{},"134":{},"135":{},"136":{},"137":{},"138":{},"139":{},"140":{},"141":{},"142":{},"143":{},"144":{}}}],["internal>.livestreamdata",{"_index":271,"name":{},"parent":{"449":{},"450":{},"451":{}}}],["internal>.playlistjson",{"_index":299,"name":{},"parent":{"505":{},"506":{},"507":{},"508":{},"509":{},"510":{},"511":{},"512":{},"513":{},"514":{},"519":{},"532":{},"533":{},"534":{},"535":{},"536":{},"537":{},"538":{},"539":{}}}],["internal>.playlistjson.__type",{"_index":300,"name":{},"parent":{"515":{},"516":{},"517":{},"518":{}}}],["internal>.playlistoptions",{"_index":199,"name":{},"parent":{"329":{},"330":{}}}],["internal>.proxyopts",{"_index":309,"name":{},"parent":{"562":{},"563":{},"564":{},"565":{}}}],["internal>.proxyopts.__type",{"_index":313,"name":{},"parent":{"566":{},"567":{}}}],["internal>.searchoptions",{"_index":193,"name":{},"parent":{"320":{},"321":{},"322":{},"327":{}}}],["internal>.searchoptions.__type",{"_index":195,"name":{},"parent":{"323":{},"324":{},"325":{},"326":{}}}],["internal>.soundcloudplaylist",{"_index":133,"name":{},"parent":{"210":{},"211":{},"212":{},"213":{},"214":{},"215":{},"216":{},"217":{},"218":{},"219":{},"220":{},"221":{},"222":{},"223":{},"224":{}}}],["internal>.soundcloudtrack",{"_index":127,"name":{},"parent":{"196":{},"197":{},"198":{},"199":{},"200":{},"201":{},"202":{},"203":{},"204":{},"205":{},"206":{},"207":{},"208":{}}}],["internal>.soundcloudtrackdeprecated",{"_index":254,"name":{},"parent":{"420":{},"421":{},"422":{}}}],["internal>.soundcloudtrackformat",{"_index":242,"name":{},"parent":{"400":{},"401":{},"402":{},"403":{},"404":{},"407":{}}}],["internal>.soundcloudtrackformat.__type",{"_index":246,"name":{},"parent":{"405":{},"406":{}}}],["internal>.soundclouduser",{"_index":249,"name":{},"parent":{"409":{},"410":{},"411":{},"412":{},"413":{},"414":{},"415":{},"416":{},"417":{},"418":{}}}],["internal>.soundtrackjson",{"_index":306,"name":{},"parent":{"551":{},"552":{},"553":{},"554":{},"555":{},"556":{},"557":{},"558":{},"559":{},"560":{}}}],["internal>.spotifyalbum",{"_index":108,"name":{},"parent":{"146":{},"147":{},"148":{},"149":{},"150":{},"151":{},"152":{},"153":{},"154":{},"155":{},"156":{},"157":{},"158":{},"159":{},"160":{},"161":{},"162":{},"163":{}}}],["internal>.spotifyartists",{"_index":226,"name":{},"parent":{"374":{},"375":{},"376":{}}}],["internal>.spotifycopyright",{"_index":229,"name":{},"parent":{"378":{},"379":{}}}],["internal>.spotifydataoptions",{"_index":231,"name":{},"parent":{"381":{},"382":{},"383":{},"384":{},"385":{},"386":{},"387":{},"388":{},"389":{},"390":{},"391":{}}}],["internal>.spotifyplaylist",{"_index":118,"name":{},"parent":{"165":{},"166":{},"167":{},"168":{},"169":{},"170":{},"171":{},"172":{},"173":{},"174":{},"175":{},"176":{},"177":{},"178":{},"179":{},"180":{},"181":{}}}],["internal>.spotifythumbnail",{"_index":224,"name":{},"parent":{"370":{},"371":{},"372":{}}}],["internal>.spotifytrack",{"_index":122,"name":{},"parent":{"183":{},"184":{},"185":{},"186":{},"187":{},"188":{},"189":{},"190":{},"191":{},"192":{},"193":{},"194":{}}}],["internal>.spotifytrackalbum",{"_index":240,"name":{},"parent":{"393":{},"394":{},"395":{},"396":{},"397":{},"398":{}}}],["internal>.stream",{"_index":90,"name":{},"parent":{"109":{},"110":{},"111":{},"112":{},"113":{},"114":{},"115":{},"116":{},"117":{},"118":{},"119":{},"120":{},"121":{},"122":{},"123":{},"124":{},"125":{}}}],["internal>.streamoptions",{"_index":189,"name":{},"parent":{"316":{},"317":{},"318":{}}}],["internal>.streamtype",{"_index":174,"name":{},"parent":{"296":{},"297":{},"298":{},"299":{},"300":{}}}],["internal>.timer",{"_index":179,"name":{},"parent":{"302":{},"303":{},"304":{},"305":{},"306":{},"307":{},"308":{},"309":{},"310":{},"311":{},"312":{},"313":{},"314":{}}}],["internal>.tokenoptions",{"_index":210,"name":{},"parent":{"345":{},"346":{},"351":{},"352":{},"354":{},"355":{}}}],["internal>.tokenoptions.__type",{"_index":211,"name":{},"parent":{"347":{},"348":{},"349":{},"350":{},"353":{},"356":{}}}],["internal>.trackjson",{"_index":304,"name":{},"parent":{"541":{},"542":{},"543":{},"544":{},"545":{},"546":{},"547":{},"548":{},"549":{}}}],["internal>.videooptions",{"_index":294,"name":{},"parent":{"475":{},"476":{},"477":{},"478":{},"479":{},"480":{},"481":{},"482":{},"483":{},"484":{},"489":{},"490":{},"491":{},"492":{},"493":{},"494":{}}}],["internal>.videooptions.__type",{"_index":295,"name":{},"parent":{"485":{},"486":{},"487":{},"488":{}}}],["internal>.youtubechannel",{"_index":62,"name":{},"parent":{"68":{},"69":{},"70":{},"71":{},"72":{},"73":{},"74":{},"75":{},"76":{},"77":{},"78":{},"79":{}}}],["internal>.youtubeplaylist",{"_index":70,"name":{},"parent":{"81":{},"82":{},"83":{},"84":{},"85":{},"86":{},"87":{},"88":{},"89":{},"90":{},"91":{},"92":{},"93":{},"94":{},"95":{},"99":{},"100":{},"101":{},"102":{},"103":{},"104":{},"105":{},"106":{},"107":{}}}],["internal>.youtubeplaylist.__type",{"_index":79,"name":{},"parent":{"96":{},"97":{},"98":{}}}],["internal>.youtubethumbnail",{"_index":217,"name":{},"parent":{"358":{},"359":{},"360":{},"361":{},"362":{},"363":{}}}],["internal>.youtubevideo",{"_index":44,"name":{},"parent":{"48":{},"49":{},"50":{},"51":{},"52":{},"53":{},"54":{},"55":{},"56":{},"57":{},"58":{},"59":{},"60":{},"61":{},"62":{},"63":{},"64":{},"65":{},"66":{}}}],["interval",{"_index":101,"name":{"132":{}},"parent":{}}],["is_expired",{"_index":18,"name":{"18":{}},"parent":{}}],["islive",{"_index":270,"name":{"449":{}},"parent":{}}],["isloved",{"_index":155,"name":{"261":{}},"parent":{}}],["itag",{"_index":275,"name":{"453":{}},"parent":{}}],["label",{"_index":204,"name":{"339":{}},"parent":{}}],["last_name",{"_index":252,"name":{"417":{}},"parent":{}}],["lastmodified",{"_index":279,"name":{"458":{}},"parent":{}}],["lastupdate",{"_index":72,"name":{"86":{},"508":{}},"parent":{}}],["likes",{"_index":54,"name":{"60":{},"490":{}},"parent":{}}],["limit",{"_index":192,"name":{"320":{},"335":{}},"parent":{}}],["link",{"_index":73,"name":{"89":{},"511":{}},"parent":{}}],["live",{"_index":56,"name":{"62":{},"492":{}},"parent":{}}],["livestream",{"_index":98,"name":{"126":{}},"parent":{}}],["livestreamdata",{"_index":166,"name":{"290":{},"448":{}},"parent":{}}],["loop",{"_index":33,"name":{"36":{},"123":{}},"parent":{}}],["loudnessdb",{"_index":291,"name":{"472":{}},"parent":{}}],["market",{"_index":214,"name":{"350":{},"390":{}},"parent":{}}],["maxbpm",{"_index":208,"name":{"343":{}},"parent":{}}],["maxdurationinsec",{"_index":206,"name":{"341":{}},"parent":{}}],["medium",{"_index":264,"name":{"440":{}},"parent":{}}],["mime_type",{"_index":247,"name":{"406":{}},"parent":{}}],["mimetype",{"_index":277,"name":{"454":{}},"parent":{}}],["minbpm",{"_index":207,"name":{"342":{}},"parent":{}}],["mindurationinsec",{"_index":205,"name":{"340":{}},"parent":{}}],["name",{"_index":63,"name":{"69":{},"147":{},"166":{},"184":{},"197":{},"211":{},"374":{},"393":{},"409":{},"426":{},"444":{},"446":{},"496":{},"521":{},"532":{},"541":{},"551":{}},"parent":{}}],["next",{"_index":85,"name":{"102":{}},"parent":{}}],["numberoffans",{"_index":162,"name":{"281":{}},"parent":{}}],["oggopus",{"_index":176,"name":{"298":{}},"parent":{}}],["opus",{"_index":178,"name":{"300":{}},"parent":{}}],["owner",{"_index":120,"name":{"173":{},"538":{}},"parent":{}}],["packet_count",{"_index":102,"name":{"133":{}},"parent":{}}],["page",{"_index":87,"name":{"104":{},"160":{},"178":{}},"parent":{}}],["parser",{"_index":31,"name":{"34":{}},"parent":{}}],["partial",{"_index":142,"name":{"238":{},"258":{},"278":{}},"parent":{}}],["password",{"_index":314,"name":{"567":{}},"parent":{}}],["pause",{"_index":35,"name":{"38":{},"124":{},"143":{},"311":{}},"parent":{}}],["paused",{"_index":181,"name":{"304":{}},"parent":{}}],["per_sec_bytes",{"_index":92,"name":{"114":{}},"parent":{}}],["picture",{"_index":152,"name":{"253":{},"428":{},"447":{}},"parent":{}}],["playlist_info",{"_index":6,"name":{"6":{}},"parent":{}}],["playlistjson",{"_index":298,"name":{"504":{},"531":{}},"parent":{}}],["playlistoptions",{"_index":197,"name":{"328":{}},"parent":{}}],["port",{"_index":310,"name":{"563":{}},"parent":{}}],["preset",{"_index":243,"name":{"401":{}},"parent":{}}],["previewurl",{"_index":141,"name":{"234":{}},"parent":{}}],["private",{"_index":57,"name":{"63":{},"493":{}},"parent":{}}],["projectiontype",{"_index":283,"name":{"463":{}},"parent":{}}],["protocol",{"_index":245,"name":{"405":{}},"parent":{}}],["proxy",{"_index":96,"name":{"119":{},"317":{},"330":{},"332":{}},"parent":{}}],["proxyoptions",{"_index":222,"name":{"368":{}},"parent":{}}],["proxyopts",{"_index":307,"name":{"561":{}},"parent":{}}],["public",{"_index":151,"name":{"251":{}},"parent":{}}],["publisher",{"_index":130,"name":{"205":{},"558":{}},"parent":{}}],["quality",{"_index":95,"name":{"118":{},"316":{},"407":{},"460":{}},"parent":{}}],["qualitylabel",{"_index":282,"name":{"462":{}},"parent":{}}],["rank",{"_index":140,"name":{"232":{}},"parent":{}}],["raw",{"_index":175,"name":{"297":{}},"parent":{}}],["recordtype",{"_index":159,"name":{"272":{}},"parent":{}}],["redirect_url",{"_index":232,"name":{"383":{}},"parent":{}}],["refresh_token",{"_index":213,"name":{"349":{},"386":{}},"parent":{}}],["refreshtoken",{"_index":17,"name":{"17":{}},"parent":{}}],["related_videos",{"_index":171,"name":{"294":{}},"parent":{}}],["release_date",{"_index":111,"name":{"154":{},"396":{},"528":{}},"parent":{}}],["release_date_precision",{"_index":112,"name":{"155":{},"397":{},"529":{}},"parent":{}}],["releasedate",{"_index":145,"name":{"241":{},"282":{},"436":{}},"parent":{}}],["request",{"_index":28,"name":{"31":{},"120":{},"138":{}},"parent":{}}],["resume",{"_index":36,"name":{"39":{},"125":{},"144":{},"312":{}},"parent":{}}],["retry",{"_index":97,"name":{"121":{}},"parent":{}}],["reuse",{"_index":186,"name":{"313":{}},"parent":{}}],["role",{"_index":257,"name":{"429":{}},"parent":{}}],["search",{"_index":1,"name":{"1":{}},"parent":{}}],["searchoptions",{"_index":191,"name":{"319":{}},"parent":{}}],["segment_urls",{"_index":30,"name":{"33":{}},"parent":{}}],["segments_urls",{"_index":104,"name":{"137":{}},"parent":{}}],["settoken",{"_index":41,"name":{"45":{}},"parent":{}}],["shorttitle",{"_index":139,"name":{"229":{}},"parent":{}}],["signaturecipher",{"_index":289,"name":{"470":{}},"parent":{}}],["small",{"_index":265,"name":{"441":{}},"parent":{}}],["so_validate",{"_index":20,"name":{"21":{}},"parent":{}}],["soundcloud",{"_index":19,"name":{"20":{},"22":{},"325":{},"351":{}},"parent":{}}],["soundcloudplaylist",{"_index":132,"name":{"209":{}},"parent":{}}],["soundcloudstream",{"_index":21,"name":{"23":{}},"parent":{"24":{},"25":{},"26":{},"27":{},"28":{},"29":{},"30":{},"31":{},"32":{},"33":{},"34":{},"35":{},"36":{},"37":{},"38":{},"39":{}}}],["soundcloudtrack",{"_index":126,"name":{"195":{}},"parent":{}}],["soundcloudtrackdeprecated",{"_index":253,"name":{"419":{}},"parent":{}}],["soundcloudtrackformat",{"_index":241,"name":{"399":{}},"parent":{}}],["soundclouduser",{"_index":248,"name":{"408":{}},"parent":{}}],["soundtrackjson",{"_index":305,"name":{"550":{}},"parent":{}}],["source",{"_index":194,"name":{"321":{}},"parent":{}}],["sp_validate",{"_index":16,"name":{"16":{}},"parent":{}}],["spotify",{"_index":15,"name":{"15":{},"19":{},"324":{},"345":{}},"parent":{}}],["spotifyalbum",{"_index":107,"name":{"145":{}},"parent":{}}],["spotifyartists",{"_index":225,"name":{"373":{}},"parent":{}}],["spotifycopyright",{"_index":227,"name":{"377":{}},"parent":{}}],["spotifydata",{"_index":114,"name":{"157":{},"175":{}},"parent":{}}],["spotifydataoptions",{"_index":230,"name":{"380":{}},"parent":{}}],["spotifyplaylist",{"_index":117,"name":{"164":{}},"parent":{}}],["spotifythumbnail",{"_index":223,"name":{"369":{}},"parent":{}}],["spotifytrack",{"_index":121,"name":{"182":{}},"parent":{}}],["spotifytrackalbum",{"_index":239,"name":{"392":{}},"parent":{}}],["start",{"_index":32,"name":{"35":{},"142":{}},"parent":{}}],["stream",{"_index":0,"name":{"0":{},"25":{},"108":{},"110":{},"128":{}},"parent":{}}],["stream_from_info",{"_index":2,"name":{"2":{}},"parent":{}}],["streamoptions",{"_index":188,"name":{"315":{}},"parent":{}}],["streamtype",{"_index":172,"name":{"295":{}},"parent":{}}],["sub_type",{"_index":134,"name":{"215":{}},"parent":{}}],["subscribers",{"_index":67,"name":{"76":{},"503":{}},"parent":{}}],["tags",{"_index":58,"name":{"64":{},"494":{}},"parent":{}}],["targetdurationsec",{"_index":292,"name":{"473":{}},"parent":{}}],["text",{"_index":228,"name":{"378":{}},"parent":{}}],["thumbnail",{"_index":52,"name":{"58":{},"91":{},"151":{},"172":{},"193":{},"206":{},"418":{},"483":{},"513":{},"525":{},"537":{},"549":{},"559":{}},"parent":{}}],["time",{"_index":29,"name":{"32":{}},"parent":{}}],["time_left",{"_index":184,"name":{"309":{}},"parent":{}}],["time_start",{"_index":183,"name":{"308":{}},"parent":{}}],["time_total",{"_index":185,"name":{"310":{}},"parent":{}}],["timer",{"_index":26,"name":{"29":{},"117":{},"134":{},"301":{},"305":{}},"parent":{}}],["title",{"_index":46,"name":{"52":{},"83":{},"228":{},"250":{},"270":{},"338":{},"433":{},"477":{},"506":{}},"parent":{}}],["tojson",{"_index":60,"name":{"66":{},"79":{},"107":{},"163":{},"181":{},"194":{},"208":{},"224":{},"246":{},"266":{},"288":{},"363":{}},"parent":{}}],["token",{"_index":80,"name":{"97":{}},"parent":{}}],["token_type",{"_index":235,"name":{"387":{}},"parent":{}}],["tokenoptions",{"_index":209,"name":{"344":{}},"parent":{}}],["tostring",{"_index":59,"name":{"65":{},"78":{}},"parent":{}}],["total_pages",{"_index":88,"name":{"105":{},"161":{},"179":{}},"parent":{}}],["total_tracks",{"_index":116,"name":{"162":{},"180":{},"223":{},"398":{}},"parent":{}}],["total_videos",{"_index":89,"name":{"106":{}},"parent":{}}],["trackjson",{"_index":303,"name":{"540":{}},"parent":{}}],["trackposition",{"_index":143,"name":{"239":{}},"parent":{}}],["tracks",{"_index":136,"name":{"220":{},"264":{},"286":{}},"parent":{}}],["trackscount",{"_index":113,"name":{"156":{},"174":{},"221":{},"257":{},"277":{},"530":{},"539":{}},"parent":{}}],["type",{"_index":23,"name":{"26":{},"51":{},"73":{},"84":{},"111":{},"129":{},"148":{},"167":{},"185":{},"201":{},"214":{},"237":{},"255":{},"276":{},"379":{},"412":{},"422":{},"500":{},"522":{}},"parent":{}}],["upc",{"_index":161,"name":{"279":{}},"parent":{}}],["uploadedat",{"_index":50,"name":{"56":{},"481":{}},"parent":{}}],["url",{"_index":24,"name":{"27":{},"50":{},"74":{},"88":{},"112":{},"131":{},"149":{},"170":{},"187":{},"199":{},"213":{},"230":{},"252":{},"271":{},"360":{},"365":{},"372":{},"375":{},"394":{},"400":{},"411":{},"427":{},"434":{},"469":{},"476":{},"488":{},"501":{},"510":{},"518":{},"523":{},"535":{},"543":{},"553":{}},"parent":{}}],["user",{"_index":131,"name":{"207":{},"219":{},"560":{}},"parent":{}}],["username",{"_index":312,"name":{"566":{}},"parent":{}}],["validate",{"_index":3,"name":{"3":{}},"parent":{}}],["verified",{"_index":64,"name":{"70":{},"413":{},"497":{}},"parent":{}}],["video_basic_info",{"_index":7,"name":{"7":{}},"parent":{}}],["video_details",{"_index":170,"name":{"293":{}},"parent":{}}],["video_info",{"_index":8,"name":{"8":{}},"parent":{}}],["video_url",{"_index":94,"name":{"116":{},"135":{}},"parent":{}}],["videocount",{"_index":71,"name":{"85":{},"507":{}},"parent":{}}],["videooptions",{"_index":293,"name":{"474":{}},"parent":{}}],["videos",{"_index":74,"name":{"92":{},"519":{}},"parent":{}}],["views",{"_index":51,"name":{"57":{},"87":{},"482":{},"509":{}},"parent":{}}],["webmopus",{"_index":177,"name":{"299":{}},"parent":{}}],["width",{"_index":218,"name":{"361":{},"366":{},"371":{},"456":{},"486":{},"516":{}},"parent":{}}],["xl",{"_index":261,"name":{"438":{}},"parent":{}}],["youtube",{"_index":12,"name":{"12":{},"323":{},"354":{}},"parent":{}}],["youtubechannel",{"_index":61,"name":{"67":{}},"parent":{}}],["youtubeplaylist",{"_index":69,"name":{"80":{}},"parent":{}}],["youtubestream",{"_index":13,"name":{"13":{}},"parent":{}}],["youtubethumbnail",{"_index":216,"name":{"357":{}},"parent":{}}],["youtubevideo",{"_index":43,"name":{"47":{}},"parent":{}}],["yt_validate",{"_index":10,"name":{"10":{}},"parent":{}}]],"pipeline":[]}} \ No newline at end of file diff --git a/docs/assets/style.css b/docs/assets/style.css deleted file mode 100644 index 28f90b6..0000000 --- a/docs/assets/style.css +++ /dev/null @@ -1,1388 +0,0 @@ -@import url("./icons.css"); - -:root { - /* Light */ - --light-color-background: #fcfcfc; - --light-color-secondary-background: #fff; - --light-color-text: #222; - --light-color-text-aside: #707070; - --light-color-link: #4da6ff; - --light-color-menu-divider: #eee; - --light-color-menu-divider-focus: #000; - --light-color-menu-label: #707070; - --light-color-panel: var(--light-color-secondary-background); - --light-color-panel-divider: #eee; - --light-color-comment-tag: #707070; - --light-color-comment-tag-text: #fff; - --light-color-ts: #9600ff; - --light-color-ts-interface: #647f1b; - --light-color-ts-enum: #937210; - --light-color-ts-class: #0672de; - --light-color-ts-private: #707070; - --light-color-toolbar: #fff; - --light-color-toolbar-text: #333; - --light-icon-filter: invert(0); - --light-external-icon: url("data:image/svg+xml;utf8,"); - - /* Dark */ - --dark-color-background: #36393f; - --dark-color-secondary-background: #2f3136; - --dark-color-text: #ffffff; - --dark-color-text-aside: #e6e4e4; - --dark-color-link: #00aff4; - --dark-color-menu-divider: #eee; - --dark-color-menu-divider-focus: #000; - --dark-color-menu-label: #707070; - --dark-color-panel: var(--dark-color-secondary-background); - --dark-color-panel-divider: #818181; - --dark-color-comment-tag: #dcddde; - --dark-color-comment-tag-text: #2f3136; - --dark-color-ts: #c97dff; - --dark-color-ts-interface: #9cbe3c; - --dark-color-ts-enum: #d6ab29; - --dark-color-ts-class: #3695f3; - --dark-color-ts-private: #e2e2e2; - --dark-color-toolbar: #34373c; - --dark-color-toolbar-text: #ffffff; - --dark-icon-filter: invert(1); - --dark-external-icon: url("data:image/svg+xml;utf8,"); -} - -@media (prefers-color-scheme: light) { - :root { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); - } -} - -@media (prefers-color-scheme: dark) { - :root { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); - } -} - -body { - margin: 0; -} - -body.light { - --color-background: var(--light-color-background); - --color-secondary-background: var(--light-color-secondary-background); - --color-text: var(--light-color-text); - --color-text-aside: var(--light-color-text-aside); - --color-link: var(--light-color-link); - --color-menu-divider: var(--light-color-menu-divider); - --color-menu-divider-focus: var(--light-color-menu-divider-focus); - --color-menu-label: var(--light-color-menu-label); - --color-panel: var(--light-color-panel); - --color-panel-divider: var(--light-color-panel-divider); - --color-comment-tag: var(--light-color-comment-tag); - --color-comment-tag-text: var(--light-color-comment-tag-text); - --color-ts: var(--light-color-ts); - --color-ts-interface: var(--light-color-ts-interface); - --color-ts-enum: var(--light-color-ts-enum); - --color-ts-class: var(--light-color-ts-class); - --color-ts-private: var(--light-color-ts-private); - --color-toolbar: var(--light-color-toolbar); - --color-toolbar-text: var(--light-color-toolbar-text); - --icon-filter: var(--light-icon-filter); - --external-icon: var(--light-external-icon); -} - -body.dark { - --color-background: var(--dark-color-background); - --color-secondary-background: var(--dark-color-secondary-background); - --color-text: var(--dark-color-text); - --color-text-aside: var(--dark-color-text-aside); - --color-link: var(--dark-color-link); - --color-menu-divider: var(--dark-color-menu-divider); - --color-menu-divider-focus: var(--dark-color-menu-divider-focus); - --color-menu-label: var(--dark-color-menu-label); - --color-panel: var(--dark-color-panel); - --color-panel-divider: var(--dark-color-panel-divider); - --color-comment-tag: var(--dark-color-comment-tag); - --color-comment-tag-text: var(--dark-color-comment-tag-text); - --color-ts: var(--dark-color-ts); - --color-ts-interface: var(--dark-color-ts-interface); - --color-ts-enum: var(--dark-color-ts-enum); - --color-ts-class: var(--dark-color-ts-class); - --color-ts-private: var(--dark-color-ts-private); - --color-toolbar: var(--dark-color-toolbar); - --color-toolbar-text: var(--dark-color-toolbar-text); - --icon-filter: var(--dark-icon-filter); - --external-icon: var(--dark-external-icon); -} - -h1 { - font-size: 2em; - margin: 0.67em 0; -} - -h2 { - font-size: 1.5em; - margin: 0.83em 0; -} - -h3 { - font-size: 1.17em; - margin: 1em 0; -} - -h4, -.tsd-index-panel h3 { - font-size: 1em; - margin: 1.33em 0; -} - -h5 { - font-size: 0.83em; - margin: 1.67em 0; -} - -h6 { - font-size: 0.67em; - margin: 2.33em 0; -} - -pre { - white-space: pre; - white-space: pre-wrap; - word-wrap: break-word; -} - -dl, -menu, -ol, -ul { - margin: 1em 0; -} - -dd { - margin: 0 0 0 40px; -} - -.container { - max-width: 1200px; - margin: 0 auto; - padding: 0 40px; -} -@media (max-width: 640px) { - .container { - padding: 0 20px; - } -} - -.container-main { - padding-bottom: 200px; -} - -.row { - display: flex; - position: relative; - margin: 0 -10px; -} -.row:after { - visibility: hidden; - display: block; - content: ""; - clear: both; - height: 0; -} - -.col-4, -.col-8 { - box-sizing: border-box; - float: left; - padding: 0 10px; -} - -.col-4 { - width: 33.3333333333%; -} -.col-8 { - width: 66.6666666667%; -} - -ul.tsd-descriptions > li > :first-child, -.tsd-panel > :first-child, -.col-8 > :first-child, -.col-4 > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child, -.tsd-panel > :first-child > :first-child, -.col-8 > :first-child > :first-child, -.col-4 > :first-child > :first-child, -ul.tsd-descriptions > li > :first-child > :first-child > :first-child, -.tsd-panel > :first-child > :first-child > :first-child, -.col-8 > :first-child > :first-child > :first-child, -.col-4 > :first-child > :first-child > :first-child { - margin-top: 0; -} -ul.tsd-descriptions > li > :last-child, -.tsd-panel > :last-child, -.col-8 > :last-child, -.col-4 > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child, -.tsd-panel > :last-child > :last-child, -.col-8 > :last-child > :last-child, -.col-4 > :last-child > :last-child, -ul.tsd-descriptions > li > :last-child > :last-child > :last-child, -.tsd-panel > :last-child > :last-child > :last-child, -.col-8 > :last-child > :last-child > :last-child, -.col-4 > :last-child > :last-child > :last-child { - margin-bottom: 0; -} - -@keyframes fade-in { - from { - opacity: 0; - } - to { - opacity: 1; - } -} -@keyframes fade-out { - from { - opacity: 1; - visibility: visible; - } - to { - opacity: 0; - } -} -@keyframes fade-in-delayed { - 0% { - opacity: 0; - } - 33% { - opacity: 0; - } - 100% { - opacity: 1; - } -} -@keyframes fade-out-delayed { - 0% { - opacity: 1; - visibility: visible; - } - 66% { - opacity: 0; - } - 100% { - opacity: 0; - } -} -@keyframes shift-to-left { - from { - transform: translate(0, 0); - } - to { - transform: translate(-25%, 0); - } -} -@keyframes unshift-to-left { - from { - transform: translate(-25%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-in-from-right { - from { - transform: translate(100%, 0); - } - to { - transform: translate(0, 0); - } -} -@keyframes pop-out-to-right { - from { - transform: translate(0, 0); - visibility: visible; - } - to { - transform: translate(100%, 0); - } -} -body { - background: var(--color-background); - font-family: "Segoe UI", sans-serif; - font-size: 16px; - color: var(--color-text); -} - -a { - color: var(--color-link); - text-decoration: none; -} -a:hover { - text-decoration: underline; -} -a.external[target="_blank"] { - background-image: var(--external-icon); - background-position: top 3px right; - background-repeat: no-repeat; - padding-right: 13px; -} - -code, -pre { - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - padding: 0.2em; - margin: 0; - font-size: 14px; -} - -pre { - padding: 10px; -} -pre code { - padding: 0; - font-size: 100%; -} - -blockquote { - margin: 1em 0; - padding-left: 1em; - border-left: 4px solid gray; -} - -.tsd-typography { - line-height: 1.333em; -} -.tsd-typography ul { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-typography h4, -.tsd-typography .tsd-index-panel h3, -.tsd-index-panel .tsd-typography h3, -.tsd-typography h5, -.tsd-typography h6 { - font-size: 1em; - margin: 0; -} -.tsd-typography h5, -.tsd-typography h6 { - font-weight: normal; -} -.tsd-typography p, -.tsd-typography ul, -.tsd-typography ol { - margin: 1em 0; -} - -@media (min-width: 901px) and (max-width: 1024px) { - html .col-content { - width: 72%; - } - html .col-menu { - width: 28%; - } - html .tsd-navigation { - padding-left: 10px; - } -} -@media (max-width: 900px) { - html .col-content { - float: none; - width: 100%; - } - html .col-menu { - position: fixed !important; - overflow: auto; - -webkit-overflow-scrolling: touch; - z-index: 1024; - top: 0 !important; - bottom: 0 !important; - left: auto !important; - right: 0 !important; - width: 100%; - padding: 20px 20px 0 0; - max-width: 450px; - visibility: hidden; - background-color: var(--color-panel); - transform: translate(100%, 0); - } - html .col-menu > *:last-child { - padding-bottom: 20px; - } - html .overlay { - content: ""; - display: block; - position: fixed; - z-index: 1023; - top: 0; - left: 0; - right: 0; - bottom: 0; - background-color: rgba(0, 0, 0, 0.75); - visibility: hidden; - } - - .to-has-menu .overlay { - animation: fade-in 0.4s; - } - - .to-has-menu :is(header, footer, .col-content) { - animation: shift-to-left 0.4s; - } - - .to-has-menu .col-menu { - animation: pop-in-from-right 0.4s; - } - - .from-has-menu .overlay { - animation: fade-out 0.4s; - } - - .from-has-menu :is(header, footer, .col-content) { - animation: unshift-to-left 0.4s; - } - - .from-has-menu .col-menu { - animation: pop-out-to-right 0.4s; - } - - .has-menu body { - overflow: hidden; - } - .has-menu .overlay { - visibility: visible; - } - .has-menu :is(header, footer, .col-content) { - transform: translate(-25%, 0); - } - .has-menu .col-menu { - visibility: visible; - transform: translate(0, 0); - display: grid; - grid-template-rows: auto 1fr; - max-height: 100vh; - } - .has-menu .tsd-navigation { - max-height: 100%; - } -} - -.tsd-page-title { - padding: 70px 0 20px 0; - margin: 0 0 40px 0; - background: var(--color-panel); - box-shadow: 0 0 5px rgba(0, 0, 0, 0.35); -} -.tsd-page-title h1 { - margin: 0; -} - -.tsd-breadcrumb { - margin: 0; - padding: 0; - color: var(--color-text-aside); -} -.tsd-breadcrumb a { - color: var(--color-text-aside); - text-decoration: none; -} -.tsd-breadcrumb a:hover { - text-decoration: underline; -} -.tsd-breadcrumb li { - display: inline; -} -.tsd-breadcrumb li:after { - content: " / "; -} - -dl.tsd-comment-tags { - overflow: hidden; -} -dl.tsd-comment-tags dt { - float: left; - padding: 1px 5px; - margin: 0 10px 0 0; - border-radius: 4px; - border: 1px solid var(--color-comment-tag); - color: var(--color-comment-tag); - font-size: 0.8em; - font-weight: normal; -} -dl.tsd-comment-tags dd { - margin: 0 0 10px 0; -} -dl.tsd-comment-tags dd:before, -dl.tsd-comment-tags dd:after { - display: table; - content: " "; -} -dl.tsd-comment-tags dd pre, -dl.tsd-comment-tags dd:after { - clear: both; -} -dl.tsd-comment-tags p { - margin: 0; -} - -.tsd-panel.tsd-comment .lead { - font-size: 1.1em; - line-height: 1.333em; - margin-bottom: 2em; -} -.tsd-panel.tsd-comment .lead:last-child { - margin-bottom: 0; -} - -.toggle-protected .tsd-is-private { - display: none; -} - -.toggle-public .tsd-is-private, -.toggle-public .tsd-is-protected, -.toggle-public .tsd-is-private-protected { - display: none; -} - -.toggle-inherited .tsd-is-inherited { - display: none; -} - -.toggle-externals .tsd-is-external { - display: none; -} - -#tsd-filter { - position: relative; - display: inline-block; - height: 40px; - vertical-align: bottom; -} -.no-filter #tsd-filter { - display: none; -} -#tsd-filter .tsd-filter-group { - display: inline-block; - height: 40px; - vertical-align: bottom; - white-space: nowrap; -} -#tsd-filter input { - display: none; -} -@media (max-width: 900px) { - #tsd-filter .tsd-filter-group { - display: block; - position: absolute; - top: 40px; - right: 20px; - height: auto; - background-color: var(--color-panel); - visibility: hidden; - transform: translate(50%, 0); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - } - .has-options #tsd-filter .tsd-filter-group { - visibility: visible; - } - .to-has-options #tsd-filter .tsd-filter-group { - animation: fade-in 0.2s; - } - .from-has-options #tsd-filter .tsd-filter-group { - animation: fade-out 0.2s; - } - #tsd-filter label, - #tsd-filter .tsd-select { - display: block; - padding-right: 20px; - } -} - -footer { - border-top: 1px solid var(--color-panel-divider); - background-color: var(--color-panel); -} -footer:after { - content: ""; - display: table; -} -footer.with-border-bottom { - border-bottom: 1px solid var(--color-panel-divider); -} -footer .tsd-legend-group { - font-size: 0; -} -footer .tsd-legend { - display: inline-block; - width: 25%; - padding: 0; - font-size: 16px; - list-style: none; - line-height: 1.333em; - vertical-align: top; -} -@media (max-width: 900px) { - footer .tsd-legend { - width: 50%; - } -} - -.tsd-hierarchy { - list-style: square; - padding: 0 0 0 20px; - margin: 0; -} -.tsd-hierarchy .target { - font-weight: bold; -} - -.tsd-index-panel .tsd-index-content { - margin-bottom: -30px !important; -} -.tsd-index-panel .tsd-index-section { - margin-bottom: 30px !important; -} -.tsd-index-panel h3 { - margin: 0 -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 3; - -moz-column-count: 3; - -ms-column-count: 3; - -o-column-count: 3; - column-count: 3; - -webkit-column-gap: 20px; - -moz-column-gap: 20px; - -ms-column-gap: 20px; - -o-column-gap: 20px; - column-gap: 20px; - padding: 0; - list-style: none; - line-height: 1.333em; -} -@media (max-width: 900px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 1; - -moz-column-count: 1; - -ms-column-count: 1; - -o-column-count: 1; - column-count: 1; - } -} -@media (min-width: 901px) and (max-width: 1024px) { - .tsd-index-panel ul.tsd-index-list { - -webkit-column-count: 2; - -moz-column-count: 2; - -ms-column-count: 2; - -o-column-count: 2; - column-count: 2; - } -} -.tsd-index-panel ul.tsd-index-list li { - -webkit-page-break-inside: avoid; - -moz-page-break-inside: avoid; - -ms-page-break-inside: avoid; - -o-page-break-inside: avoid; - page-break-inside: avoid; -} -.tsd-index-panel a, -.tsd-index-panel .tsd-parent-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-parent-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-parent-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-parent-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-kind-module a { - color: var(--color-ts); -} -.tsd-index-panel .tsd-kind-interface a { - color: var(--color-ts-interface); -} -.tsd-index-panel .tsd-kind-enum a { - color: var(--color-ts-enum); -} -.tsd-index-panel .tsd-kind-class a { - color: var(--color-ts-class); -} -.tsd-index-panel .tsd-is-private a { - color: var(--color-ts-private); -} - -.tsd-flag { - display: inline-block; - padding: 1px 5px; - border-radius: 4px; - color: var(--color-comment-tag-text); - background-color: var(--color-comment-tag); - text-indent: 0; - font-size: 14px; - font-weight: normal; -} - -.tsd-anchor { - position: absolute; - top: -100px; -} - -.tsd-member { - position: relative; -} -.tsd-member .tsd-anchor + h3 { - margin-top: 0; - margin-bottom: 0; - border-bottom: none; -} -.tsd-member [data-tsd-kind] { - color: var(--color-ts); -} -.tsd-member [data-tsd-kind="Interface"] { - color: var(--color-ts-interface); -} -.tsd-member [data-tsd-kind="Enum"] { - color: var(--color-ts-enum); -} -.tsd-member [data-tsd-kind="Class"] { - color: var(--color-ts-class); -} -.tsd-member [data-tsd-kind="Private"] { - color: var(--color-ts-private); -} - -.tsd-navigation { - margin: 0 0 0 40px; -} -.tsd-navigation a { - display: block; - padding-top: 2px; - padding-bottom: 2px; - border-left: 2px solid transparent; - color: var(--color-text); - text-decoration: none; - transition: border-left-color 0.1s; -} -.tsd-navigation a:hover { - text-decoration: underline; -} -.tsd-navigation ul { - margin: 0; - padding: 0; - list-style: none; -} -.tsd-navigation li { - padding: 0; -} - -.tsd-navigation.primary { - padding-bottom: 40px; -} -.tsd-navigation.primary a { - display: block; - padding-top: 6px; - padding-bottom: 6px; -} -.tsd-navigation.primary ul li a { - padding-left: 5px; -} -.tsd-navigation.primary ul li li a { - padding-left: 25px; -} -.tsd-navigation.primary ul li li li a { - padding-left: 45px; -} -.tsd-navigation.primary ul li li li li a { - padding-left: 65px; -} -.tsd-navigation.primary ul li li li li li a { - padding-left: 85px; -} -.tsd-navigation.primary ul li li li li li li a { - padding-left: 105px; -} -.tsd-navigation.primary > ul { - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li { - border-top: 1px solid var(--color-panel-divider); -} -.tsd-navigation.primary li.current > a { - font-weight: bold; -} -.tsd-navigation.primary li.label span { - display: block; - padding: 20px 0 6px 5px; - color: var(--color-menu-label); -} -.tsd-navigation.primary li.globals + li > span, -.tsd-navigation.primary li.globals + li > a { - padding-top: 20px; -} - -.tsd-navigation.secondary { - max-height: calc(100vh - 1rem - 40px); - overflow: auto; - position: sticky; - top: calc(0.5rem + 40px); - transition: 0.3s; -} -.tsd-navigation.secondary.tsd-navigation--toolbar-hide { - max-height: calc(100vh - 1rem); - top: 0.5rem; -} -.tsd-navigation.secondary ul { - transition: opacity 0.2s; -} -.tsd-navigation.secondary ul li a { - padding-left: 25px; -} -.tsd-navigation.secondary ul li li a { - padding-left: 45px; -} -.tsd-navigation.secondary ul li li li a { - padding-left: 65px; -} -.tsd-navigation.secondary ul li li li li a { - padding-left: 85px; -} -.tsd-navigation.secondary ul li li li li li a { - padding-left: 105px; -} -.tsd-navigation.secondary ul li li li li li li a { - padding-left: 125px; -} -.tsd-navigation.secondary ul.current a { - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.focus > a, -.tsd-navigation.secondary ul.current li.focus > a { - border-left-color: var(--color-menu-divider-focus); -} -.tsd-navigation.secondary li.current { - margin-top: 20px; - margin-bottom: 20px; - border-left-color: var(--color-panel-divider); -} -.tsd-navigation.secondary li.current > a { - font-weight: bold; -} - -@media (min-width: 901px) { - .menu-sticky-wrap { - position: static; - } -} - -.tsd-panel { - margin: 20px 0; - padding: 20px; - background-color: var(--color-panel); - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -.tsd-panel:empty { - display: none; -} -.tsd-panel > h1, -.tsd-panel > h2, -.tsd-panel > h3 { - margin: 1.5em -20px 10px -20px; - padding: 0 20px 10px 20px; - border-bottom: 1px solid var(--color-panel-divider); -} -.tsd-panel > h1.tsd-before-signature, -.tsd-panel > h2.tsd-before-signature, -.tsd-panel > h3.tsd-before-signature { - margin-bottom: 0; - border-bottom: 0; -} -.tsd-panel table { - display: block; - width: 100%; - overflow: auto; - margin-top: 10px; - word-break: normal; - word-break: keep-all; - border-collapse: collapse; -} -.tsd-panel table th { - font-weight: bold; -} -.tsd-panel table th, -.tsd-panel table td { - padding: 6px 13px; - border: 1px solid var(--color-panel-divider); -} -.tsd-panel table tr { - background: var(--color-background); -} -.tsd-panel table tr:nth-child(even) { - background: var(--color-secondary-background); -} - -.tsd-panel-group { - margin: 60px 0; -} -.tsd-panel-group > h1, -.tsd-panel-group > h2, -.tsd-panel-group > h3 { - padding-left: 20px; - padding-right: 20px; -} - -#tsd-search { - transition: background-color 0.2s; -} -#tsd-search .title { - position: relative; - z-index: 2; -} -#tsd-search .field { - position: absolute; - left: 0; - top: 0; - right: 40px; - height: 40px; -} -#tsd-search .field input { - box-sizing: border-box; - position: relative; - top: -50px; - z-index: 1; - width: 100%; - padding: 0 10px; - opacity: 0; - outline: 0; - border: 0; - background: transparent; - color: var(--color-text); -} -#tsd-search .field label { - position: absolute; - overflow: hidden; - right: -40px; -} -#tsd-search .field input, -#tsd-search .title { - transition: opacity 0.2s; -} -#tsd-search .results { - position: absolute; - visibility: hidden; - top: 40px; - width: 100%; - margin: 0; - padding: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); -} -#tsd-search .results li { - padding: 0 10px; - background-color: var(--color-background); -} -#tsd-search .results li:nth-child(even) { - background-color: var(--color-panel); -} -#tsd-search .results li.state { - display: none; -} -#tsd-search .results li.current, -#tsd-search .results li:hover { - background-color: var(--color-panel-divider); -} -#tsd-search .results a { - display: block; -} -#tsd-search .results a:before { - top: 10px; -} -#tsd-search .results span.parent { - color: var(--color-text-aside); - font-weight: normal; -} -#tsd-search.has-focus { - background-color: var(--color-panel-divider); -} -#tsd-search.has-focus .field input { - top: 0; - opacity: 1; -} -#tsd-search.has-focus .title { - z-index: 0; - opacity: 0; -} -#tsd-search.has-focus .results { - visibility: visible; -} -#tsd-search.loading .results li.state.loading { - display: block; -} -#tsd-search.failure .results li.state.failure { - display: block; -} - -.tsd-signature { - margin: 0 0 1em 0; - padding: 10px; - border: 1px solid var(--color-panel-divider); - font-family: Menlo, Monaco, Consolas, "Courier New", monospace; - font-size: 14px; - overflow-x: auto; -} -.tsd-signature.tsd-kind-icon { - padding-left: 30px; -} -.tsd-signature.tsd-kind-icon:before { - top: 10px; - left: 10px; -} -.tsd-panel > .tsd-signature { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signature.tsd-kind-icon:before { - left: 20px; -} - -.tsd-signature-symbol { - color: var(--color-text-aside); - font-weight: normal; -} - -.tsd-signature-type { - font-style: italic; - font-weight: normal; -} - -.tsd-signatures { - padding: 0; - margin: 0 0 1em 0; - border: 1px solid var(--color-panel-divider); -} -.tsd-signatures .tsd-signature { - margin: 0; - border-width: 1px 0 0 0; - transition: background-color 0.1s; -} -.tsd-signatures .tsd-signature:first-child { - border-top-width: 0; -} -.tsd-signatures .tsd-signature.current { - background-color: var(--color-panel-divider); -} -.tsd-signatures.active > .tsd-signature { - cursor: pointer; -} -.tsd-panel > .tsd-signatures { - margin-left: -20px; - margin-right: -20px; - border-width: 1px 0; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon { - padding-left: 40px; -} -.tsd-panel > .tsd-signatures .tsd-signature.tsd-kind-icon:before { - left: 20px; -} -.tsd-panel > a.anchor + .tsd-signatures { - border-top-width: 0; - margin-top: -20px; -} - -ul.tsd-descriptions { - position: relative; - overflow: hidden; - padding: 0; - list-style: none; -} -ul.tsd-descriptions.active > .tsd-description { - display: none; -} -ul.tsd-descriptions.active > .tsd-description.current { - display: block; -} -ul.tsd-descriptions.active > .tsd-description.fade-in { - animation: fade-in-delayed 0.3s; -} -ul.tsd-descriptions.active > .tsd-description.fade-out { - animation: fade-out-delayed 0.3s; - position: absolute; - display: block; - top: 0; - left: 0; - right: 0; - opacity: 0; - visibility: hidden; -} -ul.tsd-descriptions h4, -ul.tsd-descriptions .tsd-index-panel h3, -.tsd-index-panel ul.tsd-descriptions h3 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} - -ul.tsd-parameters, -ul.tsd-type-parameters { - list-style: square; - margin: 0; - padding-left: 20px; -} -ul.tsd-parameters > li.tsd-parameter-signature, -ul.tsd-type-parameters > li.tsd-parameter-signature { - list-style: none; - margin-left: -20px; -} -ul.tsd-parameters h5, -ul.tsd-type-parameters h5 { - font-size: 16px; - margin: 1em 0 0.5em 0; -} -ul.tsd-parameters .tsd-comment, -ul.tsd-type-parameters .tsd-comment { - margin-top: -0.5em; -} - -.tsd-sources { - font-size: 14px; - color: var(--color-text-aside); - margin: 0 0 1em 0; -} -.tsd-sources a { - color: var(--color-text-aside); - text-decoration: underline; -} -.tsd-sources ul, -.tsd-sources p { - margin: 0 !important; -} -.tsd-sources ul { - list-style: none; - padding: 0; -} - -.tsd-page-toolbar { - position: fixed; - z-index: 1; - top: 0; - left: 0; - width: 100%; - height: 40px; - color: var(--color-toolbar-text); - background: var(--color-toolbar); - border-bottom: 1px solid var(--color-panel-divider); - transition: transform 0.3s linear; -} -.tsd-page-toolbar a { - color: var(--color-toolbar-text); - text-decoration: none; -} -.tsd-page-toolbar a.title { - font-weight: bold; -} -.tsd-page-toolbar a.title:hover { - text-decoration: underline; -} -.tsd-page-toolbar .table-wrap { - display: table; - width: 100%; - height: 40px; -} -.tsd-page-toolbar .table-cell { - display: table-cell; - position: relative; - white-space: nowrap; - line-height: 40px; -} -.tsd-page-toolbar .table-cell:first-child { - width: 100%; -} - -.tsd-page-toolbar--hide { - transform: translateY(-100%); -} - -.tsd-select .tsd-select-list li:before, -.tsd-select .tsd-select-label:before, -.tsd-widget:before { - content: ""; - display: inline-block; - width: 40px; - height: 40px; - margin: 0 -8px 0 0; - background-image: url(./widgets.png); - background-repeat: no-repeat; - text-indent: -1024px; - vertical-align: bottom; - filter: var(--icon-filter); -} -@media (-webkit-min-device-pixel-ratio: 1.5), (min-resolution: 144dpi) { - .tsd-select .tsd-select-list li:before, - .tsd-select .tsd-select-label:before, - .tsd-widget:before { - background-image: url(./widgets@2x.png); - background-size: 320px 40px; - } -} - -.tsd-widget { - display: inline-block; - overflow: hidden; - opacity: 0.8; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-widget:hover { - opacity: 0.9; -} -.tsd-widget.active { - opacity: 1; - background-color: var(--color-panel-divider); -} -.tsd-widget.no-caption { - width: 40px; -} -.tsd-widget.no-caption:before { - margin: 0; -} -.tsd-widget.search:before { - background-position: 0 0; -} -.tsd-widget.menu:before { - background-position: -40px 0; -} -.tsd-widget.options:before { - background-position: -80px 0; -} -.tsd-widget.options, -.tsd-widget.menu { - display: none; -} -@media (max-width: 900px) { - .tsd-widget.options, - .tsd-widget.menu { - display: inline-block; - } -} -input[type="checkbox"] + .tsd-widget:before { - background-position: -120px 0; -} -input[type="checkbox"]:checked + .tsd-widget:before { - background-position: -160px 0; -} - -.tsd-select { - position: relative; - display: inline-block; - height: 40px; - transition: opacity 0.1s, background-color 0.2s; - vertical-align: bottom; - cursor: pointer; -} -.tsd-select .tsd-select-label { - opacity: 0.6; - transition: opacity 0.2s; -} -.tsd-select .tsd-select-label:before { - background-position: -240px 0; -} -.tsd-select.active .tsd-select-label { - opacity: 0.8; -} -.tsd-select.active .tsd-select-list { - visibility: visible; - opacity: 1; - transition-delay: 0s; -} -.tsd-select .tsd-select-list { - position: absolute; - visibility: hidden; - top: 40px; - left: 0; - margin: 0; - padding: 0; - opacity: 0; - list-style: none; - box-shadow: 0 0 4px rgba(0, 0, 0, 0.25); - transition: visibility 0s 0.2s, opacity 0.2s; -} -.tsd-select .tsd-select-list li { - padding: 0 20px 0 0; - background-color: var(--color-background); -} -.tsd-select .tsd-select-list li:before { - background-position: 40px 0; -} -.tsd-select .tsd-select-list li:nth-child(even) { - background-color: var(--color-panel); -} -.tsd-select .tsd-select-list li:hover { - background-color: var(--color-panel-divider); -} -.tsd-select .tsd-select-list li.selected:before { - background-position: -200px 0; -} -@media (max-width: 900px) { - .tsd-select .tsd-select-list { - top: 0; - left: auto; - right: 100%; - margin-right: -5px; - } - .tsd-select .tsd-select-label:before { - background-position: -280px 0; - } -} - -img { - max-width: 100%; -} diff --git a/docs/assets/widgets.png b/docs/assets/widgets.png deleted file mode 100644 index c738053..0000000 Binary files a/docs/assets/widgets.png and /dev/null differ diff --git a/docs/assets/widgets@2x.png b/docs/assets/widgets@2x.png deleted file mode 100644 index 4bbbd57..0000000 Binary files a/docs/assets/widgets@2x.png and /dev/null differ diff --git a/docs/classes/SoundCloudStream.html b/docs/classes/SoundCloudStream.html deleted file mode 100644 index 6390bad..0000000 --- a/docs/classes/SoundCloudStream.html +++ /dev/null @@ -1,3 +0,0 @@ -SoundCloudStream | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SoundCloudStream

-

SoundCloud Stream class

-

Hierarchy

  • SoundCloudStream

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private downloaded_segments

downloaded_segments: number

Private downloaded_time

downloaded_time: number

Private request

request: null | IncomingMessage

Private segment_urls

segment_urls: string[]

stream

stream: <internal>.Readable

Private time

time: number[]

Private timer

timer: <internal>.Timer

type

type: StreamType

Private url

url: string

Methods

Private cleanup

  • cleanup(): void

Private loop

Private parser

pause

  • pause(): void

resume

  • resume(): void

Private start

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.DeezerAlbum.html b/docs/classes/_internal_.DeezerAlbum.html deleted file mode 100644 index 3a560e6..0000000 --- a/docs/classes/_internal_.DeezerAlbum.html +++ /dev/null @@ -1,7 +0,0 @@ -DeezerAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeezerAlbum

-

Class for Deezer Albums

-

Hierarchy

  • DeezerAlbum

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DeezerAlbum(data: any, partial: boolean): DeezerAlbum

Properties

artist

artist: DeezerArtist

Optional available

available?: boolean

Optional contributors

contributors?: DeezerArtist[]

cover

cover: DeezerImage

Optional durationInSec

durationInSec?: number

explicit

explicit: boolean

Optional genres

genres?: DeezerGenre[]

id

id: number

Optional numberOfFans

numberOfFans?: number

partial

partial: boolean
-

true for albums in search results and false if the album was fetched directly.

-

recordType

recordType: string

Optional releaseDate

releaseDate?: <internal>.Date

title

title: string

tracks

tracks: DeezerTrack[]

tracksCount

tracksCount: number

type

type: "album" | "playlist" | "track"

Optional upc

upc?: string

url

url: string

Methods

fetch

toJSON

  • toJSON(): { artist: DeezerArtist; available: undefined | boolean; contributors: undefined | DeezerArtist[]; cover: DeezerImage; durationInSec: undefined | number; explicit: boolean; genres: undefined | DeezerGenre[]; id: number; numberOfFans: undefined | number; recordType: string; releaseDate: undefined | <internal>.Date; title: string; tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "album" | "playlist" | "track"; url: string }[]; tracksCount: number; type: "album" | "playlist" | "track"; upc: undefined | string; url: string }

  • Returns { artist: DeezerArtist; available: undefined | boolean; contributors: undefined | DeezerArtist[]; cover: DeezerImage; durationInSec: undefined | number; explicit: boolean; genres: undefined | DeezerGenre[]; id: number; numberOfFans: undefined | number; recordType: string; releaseDate: undefined | <internal>.Date; title: string; tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "album" | "playlist" | "track"; url: string }[]; tracksCount: number; type: "album" | "playlist" | "track"; upc: undefined | string; url: string }

    • artist: DeezerArtist
    • available: undefined | boolean
    • contributors: undefined | DeezerArtist[]
    • cover: DeezerImage
    • durationInSec: undefined | number
    • explicit: boolean
    • genres: undefined | DeezerGenre[]
    • id: number
    • numberOfFans: undefined | number
    • recordType: string
    • releaseDate: undefined | <internal>.Date
    • title: string
    • tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "album" | "playlist" | "track"; url: string }[]
    • tracksCount: number
    • type: "album" | "playlist" | "track"
    • upc: undefined | string
    • url: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.DeezerArtist.html b/docs/classes/_internal_.DeezerArtist.html deleted file mode 100644 index c8894d4..0000000 --- a/docs/classes/_internal_.DeezerArtist.html +++ /dev/null @@ -1 +0,0 @@ -DeezerArtist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeezerArtist

Hierarchy

  • DeezerArtist

Index

Constructors

Properties

Constructors

constructor

Properties

id

id: number

name

name: string

Optional picture

picture?: DeezerImage

Optional role

role?: string

url

url: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.DeezerPlaylist.html b/docs/classes/_internal_.DeezerPlaylist.html deleted file mode 100644 index ce63602..0000000 --- a/docs/classes/_internal_.DeezerPlaylist.html +++ /dev/null @@ -1,6 +0,0 @@ -DeezerPlaylist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeezerPlaylist

-

Class for Deezer Albums

-

Hierarchy

  • DeezerPlaylist

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional collaborative

collaborative?: boolean

creationDate

creationDate: <internal>.Date

creator

creator: DeezerUser

Optional description

description?: string

Optional durationInSec

durationInSec?: number

Optional fans

fans?: number

id

id: number

Optional isLoved

isLoved?: boolean

partial

partial: boolean

picture

picture: DeezerImage

public

public: boolean

title

title: string

tracks

tracks: DeezerTrack[]

tracksCount

tracksCount: number

type

type: "album" | "playlist" | "track"

url

url: string

Methods

fetch

toJSON

  • toJSON(): { collaborative: undefined | boolean; creationDate: <internal>.Date; creator: DeezerUser; description: undefined | string; durationInSec: undefined | number; fans: undefined | number; id: number; isLoved: undefined | boolean; picture: DeezerImage; public: boolean; title: string; tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "album" | "playlist" | "track"; url: string }[]; tracksCount: number; type: "album" | "playlist" | "track"; url: string }

  • Returns { collaborative: undefined | boolean; creationDate: <internal>.Date; creator: DeezerUser; description: undefined | string; durationInSec: undefined | number; fans: undefined | number; id: number; isLoved: undefined | boolean; picture: DeezerImage; public: boolean; title: string; tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "album" | "playlist" | "track"; url: string }[]; tracksCount: number; type: "album" | "playlist" | "track"; url: string }

    • collaborative: undefined | boolean
    • creationDate: <internal>.Date
    • creator: DeezerUser
    • description: undefined | string
    • durationInSec: undefined | number
    • fans: undefined | number
    • id: number
    • isLoved: undefined | boolean
    • picture: DeezerImage
    • public: boolean
    • title: string
    • tracks: { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "album" | "playlist" | "track"; url: string }[]
    • tracksCount: number
    • type: "album" | "playlist" | "track"
    • url: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.DeezerTrack.html b/docs/classes/_internal_.DeezerTrack.html deleted file mode 100644 index b274382..0000000 --- a/docs/classes/_internal_.DeezerTrack.html +++ /dev/null @@ -1,7 +0,0 @@ -DeezerTrack | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeezerTrack

-

Class for Deezer Tracks

-

Hierarchy

  • DeezerTrack

Index

Constructors

Properties

Methods

Constructors

constructor

  • new DeezerTrack(data: any, partial: boolean): DeezerTrack

Properties

album

album: DeezerTrackAlbum

artist

artist: DeezerArtist

Optional bpm

bpm?: number

Optional contributors

contributors?: DeezerArtist[]

Optional diskNumber

diskNumber?: number

durationInSec

durationInSec: number

explicit

explicit: boolean

Optional gain

gain?: number

id

id: number

partial

partial: boolean
-

true for tracks in search results and false if the track was fetched directly.

-

previewURL

previewURL: string

rank

rank: number

Optional releaseDate

releaseDate?: <internal>.Date

shortTitle

shortTitle: string

title

title: string

Optional trackPosition

trackPosition?: number

type

type: "album" | "playlist" | "track"

url

url: string

Methods

fetch

toJSON

  • toJSON(): { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "album" | "playlist" | "track"; url: string }

  • Returns { album: DeezerTrackAlbum; artist: DeezerArtist; bpm: undefined | number; contributors: undefined | DeezerArtist[]; diskNumber: undefined | number; durationInSec: number; explicit: boolean; gain: undefined | number; id: number; previewURL: string; rank: number; releaseDate: undefined | <internal>.Date; shortTitle: string; title: string; trackPosition: undefined | number; type: "album" | "playlist" | "track"; url: string }

    • album: DeezerTrackAlbum
    • artist: DeezerArtist
    • bpm: undefined | number
    • contributors: undefined | DeezerArtist[]
    • diskNumber: undefined | number
    • durationInSec: number
    • explicit: boolean
    • gain: undefined | number
    • id: number
    • previewURL: string
    • rank: number
    • releaseDate: undefined | <internal>.Date
    • shortTitle: string
    • title: string
    • trackPosition: undefined | number
    • type: "album" | "playlist" | "track"
    • url: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.DeezerTrackAlbum.html b/docs/classes/_internal_.DeezerTrackAlbum.html deleted file mode 100644 index 4c63dc3..0000000 --- a/docs/classes/_internal_.DeezerTrackAlbum.html +++ /dev/null @@ -1 +0,0 @@ -DeezerTrackAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class DeezerTrackAlbum

Hierarchy

  • DeezerTrackAlbum

Index

Constructors

Properties

Constructors

constructor

Properties

cover

cover: DeezerImage

id

id: number

Optional releaseDate

releaseDate?: <internal>.Date

title

title: string

url

url: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.Duplex.html b/docs/classes/_internal_.Duplex.html deleted file mode 100644 index c560f18..0000000 --- a/docs/classes/_internal_.Duplex.html +++ /dev/null @@ -1,403 +0,0 @@ -Duplex | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Duplex

-

Duplex streams are streams that implement both the Readable and Writable interfaces.

-

Examples of Duplex streams include:

-
    -
  • TCP sockets
    • -
  • zlib streams
    • -
  • crypto streams
    • -
-
since

v0.9.4

-

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

allowHalfOpen

allowHalfOpen: boolean
-

If false then the stream will automatically end the writable side when the -readable side ends. Set initially by the allowHalfOpen constructor option, -which defaults to false.

-

This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is -emitted.

-
since

v0.9.4

-

destroyed

destroyed: boolean
-

Is true after readable.destroy() has been called.

-
since

v8.0.0

-

readable

readable: boolean
-

Is true if it is safe to call readable.read(), which means -the stream has not been destroyed or emitted 'error' or 'end'.

-
since

v11.4.0

-

Readonly readableAborted

readableAborted: boolean
-

Returns whether the stream was destroyed or errored before emitting 'end'.

-
since

v16.8.0

-
experimental

Readonly readableDidRead

readableDidRead: boolean
-

Returns whether 'data' has been emitted.

-
since

v16.7.0

-
experimental

Readonly readableEncoding

readableEncoding: null | BufferEncoding
-

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

-
since

v12.7.0

-

Readonly readableEnded

readableEnded: boolean
-

Becomes true when 'end' event is emitted.

-
since

v12.9.0

-

Readonly readableFlowing

readableFlowing: null | boolean
-

This property reflects the current state of a Readable stream as described -in the Three states section.

-
since

v9.4.0

-

Readonly readableHighWaterMark

readableHighWaterMark: number
-

Returns the value of highWaterMark passed when creating this Readable.

-
since

v9.3.0

-

Readonly readableLength

readableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be read. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly readableObjectMode

readableObjectMode: boolean
-

Getter for the property objectMode of a given Readable stream.

-
since

v12.3.0

-

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

[asyncIterator]

Optional _construct

_destroy

_final

  • Parameters

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

Optional _writev

  • Parameters

    Returns void

addListener

  • -

    Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

cork

  • cork(): void

  • Returns void

destroy

  • -

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable -stream will release any internal resources and subsequent calls to push()will be ignored.

    -

    Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

    -

    Implementors should not override this method, but instead implement readable._destroy().

    -
    since

    v8.0.0

    -

    Parameters

    • Optional error: <internal>.Error
      -

      Error which will be passed as payload in 'error' event

      -

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(cb?: () => void): void
  • end(chunk: any, cb?: () => void): void
  • end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void

  • Parameters

    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

isPaused

  • isPaused(): boolean
  • -

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most -typical cases, there will be no reason to -use this method directly.

    -
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
-
    -
    since

    v0.11.14

    -

    Returns boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

pause

  • -

    The readable.pause() method will cause a stream in flowing mode to stop -emitting 'data' events, switching out of flowing mode. Any data that -becomes available will remain in the internal buffer.

    -
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
      console.log(`Received ${chunk.length} bytes of data.`);
      readable.pause();
      console.log('There will be no additional data for 1 second.');
      setTimeout(() => {
        console.log('Now data will start flowing again.');
        readable.resume();
      }, 1000);
    });
-
    -

    The readable.pause() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns <internal>.internal.Duplex

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

prependOnceListener

  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

push

  • Parameters

    Returns boolean

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

read

  • read(size?: number): any
  • -

    The readable.read() method pulls some data out of the internal buffer and -returns it. If no data available to be read, null is returned. By default, -the data will be returned as a Buffer object unless an encoding has been -specified using the readable.setEncoding() method or the stream is operating -in object mode.

    -

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which -case all of the data remaining in the internal -buffer will be returned.

    -

    If the size argument is not specified, all of the data contained in the -internal buffer will be returned.

    -

    The size argument must be less than or equal to 1 GiB.

    -

    The readable.read() method should only be called on Readable streams -operating in paused mode. In flowing mode, readable.read() is called -automatically until the internal buffer is fully drained.

    -
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
-
    -

    Each call to readable.read() returns a chunk of data, or null. The chunks -are not concatenated. A while loop is necessary to consume all data -currently in the buffer. When reading a large file .read() may return null, -having consumed all buffered content so far, but there is still more data to -come not yet buffered. In this case a new 'readable' event will be emitted -when there is more data in the buffer. Finally the 'end' event will be -emitted when there is no more data to come.

    -

    Therefore to read a file's whole contents from a readable, it is necessary -to collect chunks across multiple 'readable' events:

    -
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
-
    -

    A Readable stream in object mode will always return a single item from -a call to readable.read(size), regardless of the value of thesize argument.

    -

    If the readable.read() method returns a chunk of data, a 'data' event will -also be emitted.

    -

    Calling read after the 'end' event has -been emitted will return null. No runtime error will be raised.

    -
    since

    v0.9.4

    -

    Parameters

    • Optional size: number
      -

      Optional argument to specify how much data to read.

      -

    Returns any

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns <internal>.internal.Duplex

removeListener

  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

resume

  • -

    The readable.resume() method causes an explicitly paused Readable stream to -resume emitting 'data' events, switching the stream into flowing mode.

    -

    The readable.resume() method can be used to fully consume the data from a -stream without actually processing any of that data:

    -
    getReadableStreamSomehow()
      .resume()
      .on('end', () => {
        console.log('Reached the end, but did not read anything.');
      });
-
    -

    The readable.resume() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns <internal>.internal.Duplex

setDefaultEncoding

setEncoding

  • -

    The readable.setEncoding() method sets the character encoding for -data read from the Readable stream.

    -

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data -to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the -output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal -string format.

    -

    The Readable stream will properly handle multi-byte characters delivered -through the stream that would otherwise become improperly decoded if simply -pulled from the stream as Buffer objects.

    -
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
      assert.equal(typeof chunk, 'string');
      console.log('Got %d characters of string data:', chunk.length);
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns <internal>.internal.Duplex

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns <internal>.internal.Duplex

uncork

  • uncork(): void

  • Returns void

unpipe

  • -

    The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

    -

    If the destination is not specified, then all pipes are detached.

    -

    If the destination is specified, but no pipe is set up for it, then -the method does nothing.

    -
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional destination: WritableStream
      -

      Optional specific stream to unpipe

      -

    Returns <internal>.internal.Duplex

unshift

  • -

    Passing chunk as null signals the end of the stream (EOF) and behaves the -same as readable.push(null), after which no more data can be written. The EOF -signal is put at the end of the buffer and any buffered data will still be -flushed.

    -

    The readable.unshift() method pushes a chunk of data back into the internal -buffer. This is useful in certain situations where a stream is being consumed by -code that needs to "un-consume" some amount of data that it has optimistically -pulled out of the source, so that the data can be passed on to some other party.

    -

    The stream.unshift(chunk) method cannot be called after the 'end' event -has been emitted or a runtime error will be thrown.

    -

    Developers using stream.unshift() often should consider switching to -use of a Transform stream instead. See the API for stream implementers section for more information.

    -
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.match(/\n\n/)) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
          } else {
            // Still reading the header.
            header += str;
          }
        }
      }
    }
-
    -

    Unlike push, stream.unshift(chunk) will not -end the reading process by resetting the internal reading state of the stream. -This can cause unexpected results if readable.unshift() is called during a -read (i.e. from within a _read implementation on a -custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, -however it is best to simply avoid calling readable.unshift() while in the -process of performing a read.

    -
    since

    v0.9.11

    -

    Parameters

    • chunk: any
      -

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode -streams, chunk may be any JavaScript value.

      -
    • Optional encoding: BufferEncoding
      -

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      -

    Returns void

wrap

  • -

    Prior to Node.js 0.10, streams did not implement the entire stream module API -as it is currently defined. (See Compatibility for more information.)

    -

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

    -

    It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

    -
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns <internal>.internal.Duplex

write

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

Static from

  • -

    A utility method for creating duplex streams.

    -
      -
    • Stream converts writable stream into writable Duplex and readable stream -to Duplex.
      • -
    • Blob converts into readable Duplex.
      • -
    • string converts into readable Duplex.
      • -
    • ArrayBuffer converts into readable Duplex.
      • -
    • AsyncIterable converts into a readable Duplex. Cannot yield null.
      • -
    • AsyncGeneratorFunction converts into a readable/writable transform -Duplex. Must take a source AsyncIterable as first parameter. Cannot yield -null.
      • -
    • AsyncFunction converts into a writable Duplex. Must return -either null or undefined
      • -
    • Object ({ writable, readable }) converts readable and -writable into Stream and then combines them into Duplex where the -Duplex will write to the writable and read from the readable.
      • -
    • Promise converts into readable Duplex. Value null is ignored.
      • -
    -
    since

    v16.8.0

    -

    Parameters

    Returns <internal>.internal.Duplex

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static isDisturbed

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.EventEmitter-1.html b/docs/classes/_internal_.EventEmitter-1.html deleted file mode 100644 index 2fed609..0000000 --- a/docs/classes/_internal_.EventEmitter-1.html +++ /dev/null @@ -1,213 +0,0 @@ -EventEmitter | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EventEmitter

-

The EventEmitter class is defined and exposed by the events module:

-
const EventEmitter = require('events');
-
-

All EventEmitters emit the event 'newListener' when new listeners are -added and 'removeListener' when existing listeners are removed.

-

It supports the following option:

-
since

v0.1.26

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

addListener

  • -

    Alias for emitter.on(eventName, listener).

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.1.101

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.3.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

prependListener

  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

prependOnceListener

  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns <internal>.EventEmitter

removeListener

  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns <internal>.EventEmitter

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.IncomingMessage.html b/docs/classes/_internal_.IncomingMessage.html deleted file mode 100644 index 738bf0a..0000000 --- a/docs/classes/_internal_.IncomingMessage.html +++ /dev/null @@ -1,477 +0,0 @@ -IncomingMessage | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class IncomingMessage

-

An IncomingMessage object is created by {@link Server} or {@link ClientRequest} and passed as the first argument to the 'request' and 'response' event respectively. It may be used to -access response -status, headers and data.

-

Different from its socket value which is a subclass of stream.Duplex, theIncomingMessage itself extends stream.Readable and is created separately to -parse and emit the incoming HTTP headers and payload, as the underlying socket -may be reused multiple times in case of keep-alive.

-
since

v0.1.17

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

aborted

aborted: boolean
-

The message.aborted property will be true if the request has -been aborted.

-
since

v10.1.0

-

complete

complete: boolean
-

The message.complete property will be true if a complete HTTP message has -been received and successfully parsed.

-

This property is particularly useful as a means of determining if a client or -server fully transmitted a message before a connection was terminated:

-
const req = http.request({
  host: '127.0.0.1',
  port: 8080,
  method: 'POST'
}, (res) => {
  res.resume();
  res.on('end', () => {
    if (!res.complete)
      console.error(
        'The connection was terminated while the message was still being sent');
  });
});
-
-
since

v0.3.0

-

connection

connection: Socket
-

Alias for message.socket.

-
since

v0.1.90

-
deprecated

Since v16.0.0 - Use socket.

-

destroyed

destroyed: boolean
-

Is true after readable.destroy() has been called.

-
since

v8.0.0

-

headers

headers: IncomingHttpHeaders
-

The request/response headers object.

-

Key-value pairs of header names and values. Header names are lower-cased.

-
// Prints something like:
//
// { 'user-agent': 'curl/7.22.0',
//   host: '127.0.0.1:8000',
//   accept: '*' }
console.log(request.headers);
-
-

Duplicates in raw headers are handled in the following ways, depending on the -header name:

-
    -
  • Duplicates of age, authorization, content-length, content-type,etag, expires, from, host, if-modified-since, if-unmodified-since,last-modified, location, -max-forwards, proxy-authorization, referer,retry-after, server, or user-agent are discarded.
    • -
  • set-cookie is always an array. Duplicates are added to the array.
    • -
  • For duplicate cookie headers, the values are joined together with '; '.
    • -
  • For all other headers, the values are joined together with ', '.
    • -
-
since

v0.1.5

-

httpVersion

httpVersion: string
-

In case of server request, the HTTP version sent by the client. In the case of -client response, the HTTP version of the connected-to server. -Probably either '1.1' or '1.0'.

-

Also message.httpVersionMajor is the first integer andmessage.httpVersionMinor is the second.

-
since

v0.1.1

-

httpVersionMajor

httpVersionMajor: number

httpVersionMinor

httpVersionMinor: number

Optional method

method?: string
-

Only valid for request obtained from {@link Server}.

-

The request method as a string. Read only. Examples: 'GET', 'DELETE'.

-
since

v0.1.1

-

rawHeaders

rawHeaders: string[]
-

The raw request/response headers list exactly as they were received.

-

The keys and values are in the same list. It is not a -list of tuples. So, the even-numbered offsets are key values, and the -odd-numbered offsets are the associated values.

-

Header names are not lowercased, and duplicates are not merged.

-
// Prints something like:
//
// [ 'user-agent',
//   'this is invalid because there can be only one',
//   'User-Agent',
//   'curl/7.22.0',
//   'Host',
//   '127.0.0.1:8000',
//   'ACCEPT',
//   '*' ]
console.log(request.rawHeaders);
-
-
since

v0.11.6

-

rawTrailers

rawTrailers: string[]
-

The raw request/response trailer keys and values exactly as they were -received. Only populated at the 'end' event.

-
since

v0.11.6

-

readable

readable: boolean
-

Is true if it is safe to call readable.read(), which means -the stream has not been destroyed or emitted 'error' or 'end'.

-
since

v11.4.0

-

Readonly readableAborted

readableAborted: boolean
-

Returns whether the stream was destroyed or errored before emitting 'end'.

-
since

v16.8.0

-
experimental

Readonly readableDidRead

readableDidRead: boolean
-

Returns whether 'data' has been emitted.

-
since

v16.7.0

-
experimental

Readonly readableEncoding

readableEncoding: null | BufferEncoding
-

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

-
since

v12.7.0

-

Readonly readableEnded

readableEnded: boolean
-

Becomes true when 'end' event is emitted.

-
since

v12.9.0

-

Readonly readableFlowing

readableFlowing: null | boolean
-

This property reflects the current state of a Readable stream as described -in the Three states section.

-
since

v9.4.0

-

Readonly readableHighWaterMark

readableHighWaterMark: number
-

Returns the value of highWaterMark passed when creating this Readable.

-
since

v9.3.0

-

Readonly readableLength

readableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be read. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly readableObjectMode

readableObjectMode: boolean
-

Getter for the property objectMode of a given Readable stream.

-
since

v12.3.0

-

socket

socket: Socket
-

The net.Socket object associated with the connection.

-

With HTTPS support, use request.socket.getPeerCertificate() to obtain the -client's authentication details.

-

This property is guaranteed to be an instance of the net.Socket class, -a subclass of stream.Duplex, unless the user specified a socket -type other than net.Socket.

-
since

v0.3.0

-

Optional statusCode

statusCode?: number
-

Only valid for response obtained from {@link ClientRequest}.

-

The 3-digit HTTP response status code. E.G. 404.

-
since

v0.1.1

-

Optional statusMessage

statusMessage?: string
-

Only valid for response obtained from {@link ClientRequest}.

-

The HTTP response status message (reason phrase). E.G. OK or Internal Server Error.

-
since

v0.11.10

-

trailers

trailers: Dict<string>
-

The request/response trailers object. Only populated at the 'end' event.

-
since

v0.3.0

-

Optional url

url?: string
-

Only valid for request obtained from {@link Server}.

-

Request URL string. This contains only the URL that is present in the actual -HTTP request. Take the following request:

-
GET /status?name=ryan HTTP/1.1
-Accept: text/plain
-
-

To parse the URL into its parts:

-
new URL(request.url, `http://${request.headers.host}`);
-
-

When request.url is '/status?name=ryan' andrequest.headers.host is 'localhost:3000':

-
$ node
-> new URL(request.url, `http://${request.headers.host}`)
-URL {
-  href: 'http://localhost:3000/status?name=ryan',
-  origin: 'http://localhost:3000',
-  protocol: 'http:',
-  username: '',
-  password: '',
-  host: 'localhost:3000',
-  hostname: 'localhost',
-  port: '3000',
-  pathname: '/status',
-  search: '?name=ryan',
-  searchParams: URLSearchParams { 'name' => 'ryan' },
-  hash: ''
-}
-
-
since

v0.1.90

-

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

[asyncIterator]

Optional _construct

_destroy

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • -

    Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns IncomingMessage

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    Returns IncomingMessage

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IncomingMessage

destroy

  • -

    Calls destroy() on the socket that received the IncomingMessage. If erroris provided, an 'error' event is emitted on the socket and error is passed -as an argument to any listeners on the event.

    -
    since

    v0.3.0

    -

    Parameters

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

isPaused

  • isPaused(): boolean
  • -

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most -typical cases, there will be no reason to -use this method directly.

    -
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
-
    -
    since

    v0.11.14

    -

    Returns boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): IncomingMessage
  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IncomingMessage

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns IncomingMessage

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    Returns IncomingMessage

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IncomingMessage

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns IncomingMessage

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    Returns IncomingMessage

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IncomingMessage

pause

  • -

    The readable.pause() method will cause a stream in flowing mode to stop -emitting 'data' events, switching out of flowing mode. Any data that -becomes available will remain in the internal buffer.

    -
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
      console.log(`Received ${chunk.length} bytes of data.`);
      readable.pause();
      console.log('There will be no additional data for 1 second.');
      setTimeout(() => {
        console.log('Now data will start flowing again.');
        readable.resume();
      }, 1000);
    });
-
    -

    The readable.pause() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns IncomingMessage

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns IncomingMessage

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    Returns IncomingMessage

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IncomingMessage

prependOnceListener

  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns IncomingMessage

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    Returns IncomingMessage

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IncomingMessage

push

  • Parameters

    Returns boolean

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

read

  • read(size?: number): any
  • -

    The readable.read() method pulls some data out of the internal buffer and -returns it. If no data available to be read, null is returned. By default, -the data will be returned as a Buffer object unless an encoding has been -specified using the readable.setEncoding() method or the stream is operating -in object mode.

    -

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which -case all of the data remaining in the internal -buffer will be returned.

    -

    If the size argument is not specified, all of the data contained in the -internal buffer will be returned.

    -

    The size argument must be less than or equal to 1 GiB.

    -

    The readable.read() method should only be called on Readable streams -operating in paused mode. In flowing mode, readable.read() is called -automatically until the internal buffer is fully drained.

    -
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
-
    -

    Each call to readable.read() returns a chunk of data, or null. The chunks -are not concatenated. A while loop is necessary to consume all data -currently in the buffer. When reading a large file .read() may return null, -having consumed all buffered content so far, but there is still more data to -come not yet buffered. In this case a new 'readable' event will be emitted -when there is more data in the buffer. Finally the 'end' event will be -emitted when there is no more data to come.

    -

    Therefore to read a file's whole contents from a readable, it is necessary -to collect chunks across multiple 'readable' events:

    -
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
-
    -

    A Readable stream in object mode will always return a single item from -a call to readable.read(size), regardless of the value of thesize argument.

    -

    If the readable.read() method returns a chunk of data, a 'data' event will -also be emitted.

    -

    Calling read after the 'end' event has -been emitted will return null. No runtime error will be raised.

    -
    since

    v0.9.4

    -

    Parameters

    • Optional size: number
      -

      Optional argument to specify how much data to read.

      -

    Returns any

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns IncomingMessage

removeListener

  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns IncomingMessage

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    Returns IncomingMessage

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns IncomingMessage

resume

  • -

    The readable.resume() method causes an explicitly paused Readable stream to -resume emitting 'data' events, switching the stream into flowing mode.

    -

    The readable.resume() method can be used to fully consume the data from a -stream without actually processing any of that data:

    -
    getReadableStreamSomehow()
      .resume()
      .on('end', () => {
        console.log('Reached the end, but did not read anything.');
      });
-
    -

    The readable.resume() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns IncomingMessage

setEncoding

  • -

    The readable.setEncoding() method sets the character encoding for -data read from the Readable stream.

    -

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data -to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the -output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal -string format.

    -

    The Readable stream will properly handle multi-byte characters delivered -through the stream that would otherwise become improperly decoded if simply -pulled from the stream as Buffer objects.

    -
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
      assert.equal(typeof chunk, 'string');
      console.log('Got %d characters of string data:', chunk.length);
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns IncomingMessage

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns IncomingMessage

setTimeout

  • -

    Calls message.socket.setTimeout(msecs, callback).

    -
    since

    v0.5.9

    -

    Parameters

    • msecs: number
    • Optional callback: () => void
        • (): void

        • Returns void

    Returns IncomingMessage

unpipe

  • -

    The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

    -

    If the destination is not specified, then all pipes are detached.

    -

    If the destination is specified, but no pipe is set up for it, then -the method does nothing.

    -
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional destination: WritableStream
      -

      Optional specific stream to unpipe

      -

    Returns IncomingMessage

unshift

  • -

    Passing chunk as null signals the end of the stream (EOF) and behaves the -same as readable.push(null), after which no more data can be written. The EOF -signal is put at the end of the buffer and any buffered data will still be -flushed.

    -

    The readable.unshift() method pushes a chunk of data back into the internal -buffer. This is useful in certain situations where a stream is being consumed by -code that needs to "un-consume" some amount of data that it has optimistically -pulled out of the source, so that the data can be passed on to some other party.

    -

    The stream.unshift(chunk) method cannot be called after the 'end' event -has been emitted or a runtime error will be thrown.

    -

    Developers using stream.unshift() often should consider switching to -use of a Transform stream instead. See the API for stream implementers section for more information.

    -
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.match(/\n\n/)) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
          } else {
            // Still reading the header.
            header += str;
          }
        }
      }
    }
-
    -

    Unlike push, stream.unshift(chunk) will not -end the reading process by resetting the internal reading state of the stream. -This can cause unexpected results if readable.unshift() is called during a -read (i.e. from within a _read implementation on a -custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, -however it is best to simply avoid calling readable.unshift() while in the -process of performing a read.

    -
    since

    v0.9.11

    -

    Parameters

    • chunk: any
      -

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode -streams, chunk may be any JavaScript value.

      -
    • Optional encoding: BufferEncoding
      -

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      -

    Returns void

wrap

  • -

    Prior to Node.js 0.10, streams did not implement the entire stream module API -as it is currently defined. (See Compatibility for more information.)

    -

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

    -

    It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

    -
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns IncomingMessage

Static from

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static isDisturbed

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.LiveStream.html b/docs/classes/_internal_.LiveStream.html deleted file mode 100644 index 6c6212e..0000000 --- a/docs/classes/_internal_.LiveStream.html +++ /dev/null @@ -1,54 +0,0 @@ -LiveStream | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LiveStream

-

YouTube Live Stream class for playing audio from Live Stream videos.

-

Hierarchy

  • LiveStream

Index

Constructors

Properties

Methods

Constructors

constructor

  • new LiveStream(dash_url: string, target_interval: number, video_url: string): LiveStream
  • -

    Live Stream Class Constructor

    -

    Parameters

    • dash_url: string
      -

      dash manifest URL

      -
    • target_interval: number
      -

      interval time for fetching dash data again

      -
    • video_url: string
      -

      Live Stream video url.

      -

    Returns LiveStream

Properties

Private base_url

base_url: string
-

Base URL in dash manifest file.

-

Private dash_timer

dash_timer: <internal>.Timer
-

Timer used to update dash url so as to avoid 404 errors after long hours of streaming.

-

It updates dash_url every 30 minutes.

-

Private interval

interval: number
-

Interval to fetch data again to dash url.

-

Private packet_count

packet_count: number
-

Sequence count of urls in dash file.

-

Private request

request: null | IncomingMessage
-

Incoming message that we recieve.

-

Storing this is essential. -This helps to destroy the TCP connection completely if you stopped player in between the stream

-

Private segments_urls

segments_urls: string[]
-

Segments of url that we recieve in dash file.

-

base_url + segment_urls[0] = One complete url for one segment.

-

stream

stream: <internal>.Readable
-

Readable Stream through which data passes

-

Private timer

timer: <internal>.Timer
-

Timer that creates loop from interval time provided.

-

type

type: StreamType
-

Type of audio data that we recieved from live stream youtube url.

-

Private url

url: string
-

Given Dash URL.

-

Private video_url

video_url: string
-

Live Stream Video url.

-

Methods

Private cleanup

  • cleanup(): void

Private dash_getter

Private dash_updater

pause

  • pause(): void

resume

  • resume(): void

Private start

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.Readable.html b/docs/classes/_internal_.Readable.html deleted file mode 100644 index 8aa32a4..0000000 --- a/docs/classes/_internal_.Readable.html +++ /dev/null @@ -1,370 +0,0 @@ -Readable | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Readable

since

v0.9.4

-

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

destroyed

destroyed: boolean
-

Is true after readable.destroy() has been called.

-
since

v8.0.0

-

readable

readable: boolean
-

Is true if it is safe to call readable.read(), which means -the stream has not been destroyed or emitted 'error' or 'end'.

-
since

v11.4.0

-

Readonly readableAborted

readableAborted: boolean
-

Returns whether the stream was destroyed or errored before emitting 'end'.

-
since

v16.8.0

-
experimental

Readonly readableDidRead

readableDidRead: boolean
-

Returns whether 'data' has been emitted.

-
since

v16.7.0

-
experimental

Readonly readableEncoding

readableEncoding: null | BufferEncoding
-

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

-
since

v12.7.0

-

Readonly readableEnded

readableEnded: boolean
-

Becomes true when 'end' event is emitted.

-
since

v12.9.0

-

Readonly readableFlowing

readableFlowing: null | boolean
-

This property reflects the current state of a Readable stream as described -in the Three states section.

-
since

v9.4.0

-

Readonly readableHighWaterMark

readableHighWaterMark: number
-

Returns the value of highWaterMark passed when creating this Readable.

-
since

v9.3.0

-

Readonly readableLength

readableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be read. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly readableObjectMode

readableObjectMode: boolean
-

Getter for the property objectMode of a given Readable stream.

-
since

v12.3.0

-

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

[asyncIterator]

Optional _construct

_destroy

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • -

    Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

destroy

  • -

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable -stream will release any internal resources and subsequent calls to push()will be ignored.

    -

    Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

    -

    Implementors should not override this method, but instead implement readable._destroy().

    -
    since

    v8.0.0

    -

    Parameters

    • Optional error: <internal>.Error
      -

      Error which will be passed as payload in 'error' event

      -

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

isPaused

  • isPaused(): boolean
  • -

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most -typical cases, there will be no reason to -use this method directly.

    -
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
-
    -
    since

    v0.11.14

    -

    Returns boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

pause

  • -

    The readable.pause() method will cause a stream in flowing mode to stop -emitting 'data' events, switching out of flowing mode. Any data that -becomes available will remain in the internal buffer.

    -
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
      console.log(`Received ${chunk.length} bytes of data.`);
      readable.pause();
      console.log('There will be no additional data for 1 second.');
      setTimeout(() => {
        console.log('Now data will start flowing again.');
        readable.resume();
      }, 1000);
    });
-
    -

    The readable.pause() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns <internal>.Readable

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

prependOnceListener

  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

push

  • Parameters

    Returns boolean

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

read

  • read(size?: number): any
  • -

    The readable.read() method pulls some data out of the internal buffer and -returns it. If no data available to be read, null is returned. By default, -the data will be returned as a Buffer object unless an encoding has been -specified using the readable.setEncoding() method or the stream is operating -in object mode.

    -

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which -case all of the data remaining in the internal -buffer will be returned.

    -

    If the size argument is not specified, all of the data contained in the -internal buffer will be returned.

    -

    The size argument must be less than or equal to 1 GiB.

    -

    The readable.read() method should only be called on Readable streams -operating in paused mode. In flowing mode, readable.read() is called -automatically until the internal buffer is fully drained.

    -
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
-
    -

    Each call to readable.read() returns a chunk of data, or null. The chunks -are not concatenated. A while loop is necessary to consume all data -currently in the buffer. When reading a large file .read() may return null, -having consumed all buffered content so far, but there is still more data to -come not yet buffered. In this case a new 'readable' event will be emitted -when there is more data in the buffer. Finally the 'end' event will be -emitted when there is no more data to come.

    -

    Therefore to read a file's whole contents from a readable, it is necessary -to collect chunks across multiple 'readable' events:

    -
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
-
    -

    A Readable stream in object mode will always return a single item from -a call to readable.read(size), regardless of the value of thesize argument.

    -

    If the readable.read() method returns a chunk of data, a 'data' event will -also be emitted.

    -

    Calling read after the 'end' event has -been emitted will return null. No runtime error will be raised.

    -
    since

    v0.9.4

    -

    Parameters

    • Optional size: number
      -

      Optional argument to specify how much data to read.

      -

    Returns any

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns <internal>.Readable

removeListener

  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

resume

  • -

    The readable.resume() method causes an explicitly paused Readable stream to -resume emitting 'data' events, switching the stream into flowing mode.

    -

    The readable.resume() method can be used to fully consume the data from a -stream without actually processing any of that data:

    -
    getReadableStreamSomehow()
      .resume()
      .on('end', () => {
        console.log('Reached the end, but did not read anything.');
      });
-
    -

    The readable.resume() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns <internal>.Readable

setEncoding

  • -

    The readable.setEncoding() method sets the character encoding for -data read from the Readable stream.

    -

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data -to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the -output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal -string format.

    -

    The Readable stream will properly handle multi-byte characters delivered -through the stream that would otherwise become improperly decoded if simply -pulled from the stream as Buffer objects.

    -
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
      assert.equal(typeof chunk, 'string');
      console.log('Got %d characters of string data:', chunk.length);
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns <internal>.Readable

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns <internal>.Readable

unpipe

  • -

    The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

    -

    If the destination is not specified, then all pipes are detached.

    -

    If the destination is specified, but no pipe is set up for it, then -the method does nothing.

    -
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional destination: WritableStream
      -

      Optional specific stream to unpipe

      -

    Returns <internal>.Readable

unshift

  • -

    Passing chunk as null signals the end of the stream (EOF) and behaves the -same as readable.push(null), after which no more data can be written. The EOF -signal is put at the end of the buffer and any buffered data will still be -flushed.

    -

    The readable.unshift() method pushes a chunk of data back into the internal -buffer. This is useful in certain situations where a stream is being consumed by -code that needs to "un-consume" some amount of data that it has optimistically -pulled out of the source, so that the data can be passed on to some other party.

    -

    The stream.unshift(chunk) method cannot be called after the 'end' event -has been emitted or a runtime error will be thrown.

    -

    Developers using stream.unshift() often should consider switching to -use of a Transform stream instead. See the API for stream implementers section for more information.

    -
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.match(/\n\n/)) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
          } else {
            // Still reading the header.
            header += str;
          }
        }
      }
    }
-
    -

    Unlike push, stream.unshift(chunk) will not -end the reading process by resetting the internal reading state of the stream. -This can cause unexpected results if readable.unshift() is called during a -read (i.e. from within a _read implementation on a -custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, -however it is best to simply avoid calling readable.unshift() while in the -process of performing a read.

    -
    since

    v0.9.11

    -

    Parameters

    • chunk: any
      -

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode -streams, chunk may be any JavaScript value.

      -
    • Optional encoding: BufferEncoding
      -

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      -

    Returns void

wrap

  • -

    Prior to Node.js 0.10, streams did not implement the entire stream module API -as it is currently defined. (See Compatibility for more information.)

    -

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

    -

    It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

    -
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns <internal>.Readable

Static from

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static isDisturbed

  • -

    Returns whether the stream has been read from or cancelled.

    -
    since

    v16.8.0

    -

    Parameters

    Returns boolean

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.Socket.html b/docs/classes/_internal_.Socket.html deleted file mode 100644 index 34aadff..0000000 --- a/docs/classes/_internal_.Socket.html +++ /dev/null @@ -1,511 +0,0 @@ -Socket | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Socket

-

This class is an abstraction of a TCP socket or a streaming IPC endpoint -(uses named pipes on Windows, and Unix domain sockets otherwise). It is also -an EventEmitter.

-

A net.Socket can be created by the user and used directly to interact with -a server. For example, it is returned by {@link createConnection}, -so the user can use it to talk to the server.

-

It can also be created by Node.js and passed to the user when a connection -is received. For example, it is passed to the listeners of a 'connection' event emitted on a {@link Server}, so the user can use -it to interact with the client.

-
since

v0.3.4

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

allowHalfOpen

allowHalfOpen: boolean
-

If false then the stream will automatically end the writable side when the -readable side ends. Set initially by the allowHalfOpen constructor option, -which defaults to false.

-

This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is -emitted.

-
since

v0.9.4

-

Readonly bufferSize

bufferSize: number
-

This property shows the number of characters buffered for writing. The buffer -may contain strings whose length after encoding is not yet known. So this number -is only an approximation of the number of bytes in the buffer.

-

net.Socket has the property that socket.write() always works. This is to -help users get up and running quickly. The computer cannot always keep up -with the amount of data that is written to a socket. The network connection -simply might be too slow. Node.js will internally queue up the data written to a -socket and send it out over the wire when it is possible.

-

The consequence of this internal buffering is that memory may grow. -Users who experience large or growing bufferSize should attempt to -"throttle" the data flows in their program with socket.pause() and socket.resume().

-
since

v0.3.8

-
deprecated

Since v14.6.0 - Use writableLength instead.

-

Readonly bytesRead

bytesRead: number
-

The amount of received bytes.

-
since

v0.5.3

-

Readonly bytesWritten

bytesWritten: number
-

The amount of bytes sent.

-
since

v0.5.3

-

Readonly connecting

connecting: boolean
-

If true,socket.connect(options[, connectListener]) was -called and has not yet finished. It will stay true until the socket becomes -connected, then it is set to false and the 'connect' event is emitted. Note -that the socket.connect(options[, connectListener]) callback is a listener for the 'connect' event.

-
since

v6.1.0

-

Readonly destroyed

destroyed: boolean
-

See writable.destroyed for further details.

-

Optional Readonly localAddress

localAddress?: string
-

The string representation of the local IP address the remote client is -connecting on. For example, in a server listening on '0.0.0.0', if a client -connects on '192.168.1.1', the value of socket.localAddress would be'192.168.1.1'.

-
since

v0.9.6

-

Optional Readonly localPort

localPort?: number
-

The numeric representation of the local port. For example, 80 or 21.

-
since

v0.9.6

-

readable

readable: boolean
-

Is true if it is safe to call readable.read(), which means -the stream has not been destroyed or emitted 'error' or 'end'.

-
since

v11.4.0

-

Readonly readableAborted

readableAborted: boolean
-

Returns whether the stream was destroyed or errored before emitting 'end'.

-
since

v16.8.0

-
experimental

Readonly readableDidRead

readableDidRead: boolean
-

Returns whether 'data' has been emitted.

-
since

v16.7.0

-
experimental

Readonly readableEncoding

readableEncoding: null | BufferEncoding
-

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

-
since

v12.7.0

-

Readonly readableEnded

readableEnded: boolean
-

Becomes true when 'end' event is emitted.

-
since

v12.9.0

-

Readonly readableFlowing

readableFlowing: null | boolean
-

This property reflects the current state of a Readable stream as described -in the Three states section.

-
since

v9.4.0

-

Readonly readableHighWaterMark

readableHighWaterMark: number
-

Returns the value of highWaterMark passed when creating this Readable.

-
since

v9.3.0

-

Readonly readableLength

readableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be read. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly readableObjectMode

readableObjectMode: boolean
-

Getter for the property objectMode of a given Readable stream.

-
since

v12.3.0

-

Optional Readonly remoteAddress

remoteAddress?: string
-

The string representation of the remote IP address. For example,'74.125.127.100' or '2001:4860:a005::68'. Value may be undefined if -the socket is destroyed (for example, if the client disconnected).

-
since

v0.5.10

-

Optional Readonly remoteFamily

remoteFamily?: string
-

The string representation of the remote IP family. 'IPv4' or 'IPv6'.

-
since

v0.11.14

-

Optional Readonly remotePort

remotePort?: number
-

The numeric representation of the remote port. For example, 80 or 21.

-
since

v0.5.10

-

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

[asyncIterator]

Optional _construct

_destroy

_final

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

Optional _writev

addListener

  • addListener(event: string, listener: (...args: any[]) => void): Socket
  • addListener(event: "close", listener: (hadError: boolean) => void): Socket
  • addListener(event: "connect", listener: () => void): Socket
  • addListener(event: "data", listener: (data: <internal>.Buffer) => void): Socket
  • addListener(event: "drain", listener: () => void): Socket
  • addListener(event: "end", listener: () => void): Socket
  • addListener(event: "error", listener: (err: <internal>.Error) => void): Socket
  • addListener(event: "lookup", listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void): Socket
  • addListener(event: "ready", listener: () => void): Socket
  • addListener(event: "timeout", listener: () => void): Socket
  • -

    events.EventEmitter

    -
      -
    1. close
      2. -
    2. connect
      3. -
    3. data
      4. -
    4. drain
      5. -
    5. end
      6. -
    6. error
      7. -
    7. lookup
      8. -
    8. timeout
      9. -
    -

    Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Socket

  • Parameters

    • event: "close"
    • listener: (hadError: boolean) => void
        • (hadError: boolean): void

        • Parameters

          • hadError: boolean

          Returns void

    Returns Socket

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "lookup"
    • listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void
        • (err: <internal>.Error, address: string, family: string | number, host: string): void

        • Parameters

          Returns void

    Returns Socket

  • Parameters

    • event: "ready"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

address

  • -

    Returns the bound address, the address family name and port of the -socket as reported by the operating system:{ port: 12346, family: 'IPv4', address: '127.0.0.1' }

    -
    since

    v0.1.90

    -

    Returns {} | AddressInfo

connect

  • connect(options: SocketConnectOpts, connectionListener?: () => void): Socket
  • connect(port: number, host: string, connectionListener?: () => void): Socket
  • connect(port: number, connectionListener?: () => void): Socket
  • connect(path: string, connectionListener?: () => void): Socket
  • -

    Initiate a connection on a given socket.

    -

    Possible signatures:

    -
      -
    • socket.connect(options[, connectListener])
      • -
    • socket.connect(path[, connectListener]) for IPC connections.
      • -
    • socket.connect(port[, host][, connectListener]) for TCP connections.
      • -
    • Returns: net.Socket The socket itself.
      • -
    -

    This function is asynchronous. When the connection is established, the 'connect' event will be emitted. If there is a problem connecting, -instead of a 'connect' event, an 'error' event will be emitted with -the error passed to the 'error' listener. -The last parameter connectListener, if supplied, will be added as a listener -for the 'connect' event once.

    -

    This function should only be used for reconnecting a socket after'close' has been emitted or otherwise it may lead to undefined -behavior.

    -

    Parameters

    • options: SocketConnectOpts
    • Optional connectionListener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • port: number
    • host: string
    • Optional connectionListener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • port: number
    • Optional connectionListener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • path: string
    • Optional connectionListener: () => void
        • (): void

        • Returns void

    Returns Socket

cork

  • cork(): void

  • Returns void

destroy

  • -

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable -stream will release any internal resources and subsequent calls to push()will be ignored.

    -

    Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

    -

    Implementors should not override this method, but instead implement readable._destroy().

    -
    since

    v8.0.0

    -

    Parameters

    • Optional error: <internal>.Error
      -

      Error which will be passed as payload in 'error' event

      -

    Returns void

emit

  • emit(event: string | symbol, ...args: any[]): boolean
  • emit(event: "close", hadError: boolean): boolean
  • emit(event: "connect"): boolean
  • emit(event: "data", data: <internal>.Buffer): boolean
  • emit(event: "drain"): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "lookup", err: <internal>.Error, address: string, family: string | number, host: string): boolean
  • emit(event: "ready"): boolean
  • emit(event: "timeout"): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

  • Parameters

    • event: "close"
    • hadError: boolean

    Returns boolean

  • Parameters

    • event: "connect"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "lookup"
    • err: <internal>.Error
    • address: string
    • family: string | number
    • host: string

    Returns boolean

  • Parameters

    • event: "ready"

    Returns boolean

  • Parameters

    • event: "timeout"

    Returns boolean

end

  • -

    Half-closes the socket. i.e., it sends a FIN packet. It is possible the -server will still send some data.

    -

    See writable.end() for further details.

    -
    since

    v0.1.90

    -

    Parameters

    • Optional callback: () => void
      -

      Optional callback for when the socket is finished.

      -
        • (): void

        • Returns void

    Returns void

    The socket itself.

    -

  • Parameters

    Returns void

  • Parameters

    Returns void

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

isPaused

  • isPaused(): boolean
  • -

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most -typical cases, there will be no reason to -use this method directly.

    -
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
-
    -
    since

    v0.11.14

    -

    Returns boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): Socket
  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Socket

on

  • on(event: string, listener: (...args: any[]) => void): Socket
  • on(event: "close", listener: (hadError: boolean) => void): Socket
  • on(event: "connect", listener: () => void): Socket
  • on(event: "data", listener: (data: <internal>.Buffer) => void): Socket
  • on(event: "drain", listener: () => void): Socket
  • on(event: "end", listener: () => void): Socket
  • on(event: "error", listener: (err: <internal>.Error) => void): Socket
  • on(event: "lookup", listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void): Socket
  • on(event: "ready", listener: () => void): Socket
  • on(event: "timeout", listener: () => void): Socket
  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Socket

  • Parameters

    • event: "close"
    • listener: (hadError: boolean) => void
        • (hadError: boolean): void

        • Parameters

          • hadError: boolean

          Returns void

    Returns Socket

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "lookup"
    • listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void
        • (err: <internal>.Error, address: string, family: string | number, host: string): void

        • Parameters

          Returns void

    Returns Socket

  • Parameters

    • event: "ready"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

once

  • once(event: string, listener: (...args: any[]) => void): Socket
  • once(event: "close", listener: (hadError: boolean) => void): Socket
  • once(event: "connect", listener: () => void): Socket
  • once(event: "data", listener: (data: <internal>.Buffer) => void): Socket
  • once(event: "drain", listener: () => void): Socket
  • once(event: "end", listener: () => void): Socket
  • once(event: "error", listener: (err: <internal>.Error) => void): Socket
  • once(event: "lookup", listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void): Socket
  • once(event: "ready", listener: () => void): Socket
  • once(event: "timeout", listener: () => void): Socket
  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Socket

  • Parameters

    • event: "close"
    • listener: (hadError: boolean) => void
        • (hadError: boolean): void

        • Parameters

          • hadError: boolean

          Returns void

    Returns Socket

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "lookup"
    • listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void
        • (err: <internal>.Error, address: string, family: string | number, host: string): void

        • Parameters

          Returns void

    Returns Socket

  • Parameters

    • event: "ready"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

pause

  • -

    Pauses the reading of data. That is, 'data' events will not be emitted. -Useful to throttle back an upload.

    -

    Returns Socket

    The socket itself.

    -

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(event: string, listener: (...args: any[]) => void): Socket
  • prependListener(event: "close", listener: (hadError: boolean) => void): Socket
  • prependListener(event: "connect", listener: () => void): Socket
  • prependListener(event: "data", listener: (data: <internal>.Buffer) => void): Socket
  • prependListener(event: "drain", listener: () => void): Socket
  • prependListener(event: "end", listener: () => void): Socket
  • prependListener(event: "error", listener: (err: <internal>.Error) => void): Socket
  • prependListener(event: "lookup", listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void): Socket
  • prependListener(event: "ready", listener: () => void): Socket
  • prependListener(event: "timeout", listener: () => void): Socket
  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Socket

  • Parameters

    • event: "close"
    • listener: (hadError: boolean) => void
        • (hadError: boolean): void

        • Parameters

          • hadError: boolean

          Returns void

    Returns Socket

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "lookup"
    • listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void
        • (err: <internal>.Error, address: string, family: string | number, host: string): void

        • Parameters

          Returns void

    Returns Socket

  • Parameters

    • event: "ready"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

prependOnceListener

  • prependOnceListener(event: string, listener: (...args: any[]) => void): Socket
  • prependOnceListener(event: "close", listener: (hadError: boolean) => void): Socket
  • prependOnceListener(event: "connect", listener: () => void): Socket
  • prependOnceListener(event: "data", listener: (data: <internal>.Buffer) => void): Socket
  • prependOnceListener(event: "drain", listener: () => void): Socket
  • prependOnceListener(event: "end", listener: () => void): Socket
  • prependOnceListener(event: "error", listener: (err: <internal>.Error) => void): Socket
  • prependOnceListener(event: "lookup", listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void): Socket
  • prependOnceListener(event: "ready", listener: () => void): Socket
  • prependOnceListener(event: "timeout", listener: () => void): Socket
  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Socket

  • Parameters

    • event: "close"
    • listener: (hadError: boolean) => void
        • (hadError: boolean): void

        • Parameters

          • hadError: boolean

          Returns void

    Returns Socket

  • Parameters

    • event: "connect"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "lookup"
    • listener: (err: <internal>.Error, address: string, family: string | number, host: string) => void
        • (err: <internal>.Error, address: string, family: string | number, host: string): void

        • Parameters

          Returns void

    Returns Socket

  • Parameters

    • event: "ready"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "timeout"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

push

  • Parameters

    Returns boolean

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

read

  • read(size?: number): any
  • -

    The readable.read() method pulls some data out of the internal buffer and -returns it. If no data available to be read, null is returned. By default, -the data will be returned as a Buffer object unless an encoding has been -specified using the readable.setEncoding() method or the stream is operating -in object mode.

    -

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which -case all of the data remaining in the internal -buffer will be returned.

    -

    If the size argument is not specified, all of the data contained in the -internal buffer will be returned.

    -

    The size argument must be less than or equal to 1 GiB.

    -

    The readable.read() method should only be called on Readable streams -operating in paused mode. In flowing mode, readable.read() is called -automatically until the internal buffer is fully drained.

    -
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
-
    -

    Each call to readable.read() returns a chunk of data, or null. The chunks -are not concatenated. A while loop is necessary to consume all data -currently in the buffer. When reading a large file .read() may return null, -having consumed all buffered content so far, but there is still more data to -come not yet buffered. In this case a new 'readable' event will be emitted -when there is more data in the buffer. Finally the 'end' event will be -emitted when there is no more data to come.

    -

    Therefore to read a file's whole contents from a readable, it is necessary -to collect chunks across multiple 'readable' events:

    -
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
-
    -

    A Readable stream in object mode will always return a single item from -a call to readable.read(size), regardless of the value of thesize argument.

    -

    If the readable.read() method returns a chunk of data, a 'data' event will -also be emitted.

    -

    Calling read after the 'end' event has -been emitted will return null. No runtime error will be raised.

    -
    since

    v0.9.4

    -

    Parameters

    • Optional size: number
      -

      Optional argument to specify how much data to read.

      -

    Returns any

ref

  • -

    Opposite of unref(), calling ref() on a previously unrefed socket will_not_ let the program exit if it's the only socket left (the default behavior). -If the socket is refed calling ref again will have no effect.

    -
    since

    v0.9.1

    -

    Returns Socket

    The socket itself.

    -

removeAllListeners

  • removeAllListeners(event?: string | symbol): Socket
  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns Socket

removeListener

  • removeListener(event: "close", listener: () => void): Socket
  • removeListener(event: "data", listener: (chunk: any) => void): Socket
  • removeListener(event: "end", listener: () => void): Socket
  • removeListener(event: "error", listener: (err: <internal>.Error) => void): Socket
  • removeListener(event: "pause", listener: () => void): Socket
  • removeListener(event: "readable", listener: () => void): Socket
  • removeListener(event: "resume", listener: () => void): Socket
  • removeListener(event: string | symbol, listener: (...args: any[]) => void): Socket
  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns Socket

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    Returns Socket

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns Socket

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Socket

resume

  • -

    Resumes reading after a call to socket.pause().

    -

    Returns Socket

    The socket itself.

    -

setDefaultEncoding

setEncoding

  • -

    Set the encoding for the socket as a Readable Stream. See readable.setEncoding() for more information.

    -
    since

    v0.1.90

    -

    Parameters

    Returns Socket

    The socket itself.

    -

setKeepAlive

  • setKeepAlive(enable?: boolean, initialDelay?: number): Socket
  • -

    Enable/disable keep-alive functionality, and optionally set the initial -delay before the first keepalive probe is sent on an idle socket.

    -

    Set initialDelay (in milliseconds) to set the delay between the last -data packet received and the first keepalive probe. Setting 0 forinitialDelay will leave the value unchanged from the default -(or previous) setting.

    -

    Enabling the keep-alive functionality will set the following socket options:

    -
      -
    • SO_KEEPALIVE=1
      • -
    • TCP_KEEPIDLE=initialDelay
      • -
    • TCP_KEEPCNT=10
      • -
    • TCP_KEEPINTVL=1
      • -
    -
    since

    v0.1.92

    -

    Parameters

    • Optional enable: boolean
    • Optional initialDelay: number

    Returns Socket

    The socket itself.

    -

setMaxListeners

  • setMaxListeners(n: number): Socket
  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns Socket

setNoDelay

  • setNoDelay(noDelay?: boolean): Socket
  • -

    Enable/disable the use of Nagle's algorithm.

    -

    When a TCP connection is created, it will have Nagle's algorithm enabled.

    -

    Nagle's algorithm delays data before it is sent via the network. It attempts -to optimize throughput at the expense of latency.

    -

    Passing true for noDelay or not passing an argument will disable Nagle's -algorithm for the socket. Passing false for noDelay will enable Nagle's -algorithm.

    -
    since

    v0.1.90

    -

    Parameters

    • Optional noDelay: boolean

    Returns Socket

    The socket itself.

    -

setTimeout

  • setTimeout(timeout: number, callback?: () => void): Socket
  • -

    Sets the socket to timeout after timeout milliseconds of inactivity on -the socket. By default net.Socket do not have a timeout.

    -

    When an idle timeout is triggered the socket will receive a 'timeout' event but the connection will not be severed. The user must manually call socket.end() or socket.destroy() to -end the connection.

    -
    socket.setTimeout(3000);
    socket.on('timeout', () => {
      console.log('socket timeout');
      socket.end();
    });
-
    -

    If timeout is 0, then the existing idle timeout is disabled.

    -

    The optional callback parameter will be added as a one-time listener for the 'timeout' event.

    -
    since

    v0.1.90

    -

    Parameters

    • timeout: number
    • Optional callback: () => void
        • (): void

        • Returns void

    Returns Socket

    The socket itself.

    -

uncork

  • uncork(): void

  • Returns void

unpipe

  • -

    The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

    -

    If the destination is not specified, then all pipes are detached.

    -

    If the destination is specified, but no pipe is set up for it, then -the method does nothing.

    -
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional destination: WritableStream
      -

      Optional specific stream to unpipe

      -

    Returns Socket

unref

  • -

    Calling unref() on a socket will allow the program to exit if this is the only -active socket in the event system. If the socket is already unrefed callingunref() again will have no effect.

    -
    since

    v0.9.1

    -

    Returns Socket

    The socket itself.

    -

unshift

  • -

    Passing chunk as null signals the end of the stream (EOF) and behaves the -same as readable.push(null), after which no more data can be written. The EOF -signal is put at the end of the buffer and any buffered data will still be -flushed.

    -

    The readable.unshift() method pushes a chunk of data back into the internal -buffer. This is useful in certain situations where a stream is being consumed by -code that needs to "un-consume" some amount of data that it has optimistically -pulled out of the source, so that the data can be passed on to some other party.

    -

    The stream.unshift(chunk) method cannot be called after the 'end' event -has been emitted or a runtime error will be thrown.

    -

    Developers using stream.unshift() often should consider switching to -use of a Transform stream instead. See the API for stream implementers section for more information.

    -
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.match(/\n\n/)) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
          } else {
            // Still reading the header.
            header += str;
          }
        }
      }
    }
-
    -

    Unlike push, stream.unshift(chunk) will not -end the reading process by resetting the internal reading state of the stream. -This can cause unexpected results if readable.unshift() is called during a -read (i.e. from within a _read implementation on a -custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, -however it is best to simply avoid calling readable.unshift() while in the -process of performing a read.

    -
    since

    v0.9.11

    -

    Parameters

    • chunk: any
      -

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode -streams, chunk may be any JavaScript value.

      -
    • Optional encoding: BufferEncoding
      -

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      -

    Returns void

wrap

  • -

    Prior to Node.js 0.10, streams did not implement the entire stream module API -as it is currently defined. (See Compatibility for more information.)

    -

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

    -

    It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

    -
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns Socket

write

  • -

    Sends data on the socket. The second parameter specifies the encoding in the -case of a string. It defaults to UTF8 encoding.

    -

    Returns true if the entire data was flushed successfully to the kernel -buffer. Returns false if all or part of the data was queued in user memory.'drain' will be emitted when the buffer is again free.

    -

    The optional callback parameter will be executed when the data is finally -written out, which may not be immediately.

    -

    See Writable stream write() method for more -information.

    -
    since

    v0.1.90

    -

    Parameters

    Returns boolean

  • Parameters

    Returns boolean

Static from

  • -

    A utility method for creating duplex streams.

    -
      -
    • Stream converts writable stream into writable Duplex and readable stream -to Duplex.
      • -
    • Blob converts into readable Duplex.
      • -
    • string converts into readable Duplex.
      • -
    • ArrayBuffer converts into readable Duplex.
      • -
    • AsyncIterable converts into a readable Duplex. Cannot yield null.
      • -
    • AsyncGeneratorFunction converts into a readable/writable transform -Duplex. Must take a source AsyncIterable as first parameter. Cannot yield -null.
      • -
    • AsyncFunction converts into a writable Duplex. Must return -either null or undefined
      • -
    • Object ({ writable, readable }) converts readable and -writable into Stream and then combines them into Duplex where the -Duplex will write to the writable and read from the readable.
      • -
    • Promise converts into readable Duplex. Value null is ignored.
      • -
    -
    since

    v16.8.0

    -

    Parameters

    Returns <internal>.internal.Duplex

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static isDisturbed

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.SoundCloudPlaylist.html b/docs/classes/_internal_.SoundCloudPlaylist.html deleted file mode 100644 index e53db4f..0000000 --- a/docs/classes/_internal_.SoundCloudPlaylist.html +++ /dev/null @@ -1,3 +0,0 @@ -SoundCloudPlaylist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SoundCloudPlaylist

-

SoundCloud Playlist Class

-

Hierarchy

  • SoundCloudPlaylist

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

client_id

client_id: string

durationInMs

durationInMs: number

durationInSec

durationInSec: number

id

id: number

name

name: string

sub_type

sub_type: string

tracks

tracks: SoundCloudTrack[] | SoundCloudTrackDeprecated[]

tracksCount

tracksCount: number

type

type: "playlist" | "track" | "user"

url

url: string

user

user: SoundCloudUser

Accessors

total_tracks

  • get total_tracks(): number

Methods

fetch

toJSON

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.SoundCloudTrack.html b/docs/classes/_internal_.SoundCloudTrack.html deleted file mode 100644 index e165328..0000000 --- a/docs/classes/_internal_.SoundCloudTrack.html +++ /dev/null @@ -1,29 +0,0 @@ -SoundCloudTrack | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SoundCloudTrack

-

SoundCloud Track Class

-

Hierarchy

  • SoundCloudTrack

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

durationInMs

durationInMs: number
-

SoundCloud Track Duration in miili seconds

-

durationInSec

durationInSec: number
-

SoundCloud Track Duration in seconds

-

fetched

fetched: boolean
-

SoundCloud Track fetched status

-

formats

formats: SoundCloudTrackFormat[]
-

SoundCloud Track formats data

-

id

id: number
-

SoundCloud Track ID

-

name

name: string
-

SoundCloud Track Name

-

publisher

publisher: null | { artist: string; contains_music: boolean; id: number; name: string; writer_composer: string }
-

SoundCloud Track Publisher Data

-

thumbnail

thumbnail: string
-

SoundCloud Track thumbnail

-

type

type: "playlist" | "track" | "user"
-

SoundCloud Class type. === "track"

-

url

url: string
-

SoundCloud Track url

-

user

user: SoundCloudUser
-

SoundCloud Track user data

-

Methods

toJSON

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.SpotifyAlbum.html b/docs/classes/_internal_.SpotifyAlbum.html deleted file mode 100644 index 23e3e50..0000000 --- a/docs/classes/_internal_.SpotifyAlbum.html +++ /dev/null @@ -1,51 +0,0 @@ -SpotifyAlbum | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SpotifyAlbum

-

Spotify Album Class

-

Hierarchy

  • SpotifyAlbum

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

artists

artists: SpotifyArtists[]
-

Spotify Album artists [ array ]

-

copyrights

copyrights: SpotifyCopyright[]
-

Spotify Album copyright data [ array ]

-

Private fetched_tracks

fetched_tracks: <internal>.Map<string, SpotifyTrack[]>
-

Spotify Album fetched tracks Map

-

id

id: string
-

Spotify Album id

-

name

name: string
-

Spotify Album Name

-

release_date

release_date: string
-

Spotify Album Release date

-

release_date_precision

release_date_precision: string
-

Spotify Album Release Date precise

-

Private spotifyData

spotifyData: SpotifyDataOptions
-

Spotify Album Spotify data

-

thumbnail

thumbnail: SpotifyThumbnail
-

Spotify Album Thumbnail data

-

tracksCount

tracksCount: number
-

Spotify Album total no of tracks

-

type

type: "album" | "playlist" | "track"
-

Spotify Class type. == "album"

-

url

url: string
-

Spotify Album url

-

Accessors

total_pages

  • get total_pages(): number
  • -

    Spotify Album total no of pages in a album

    -

    For getting all songs in a album,

    -
    const album = await play.spotify('album url')

    await album.fetch()

    const result = []

    for (let i = 0; i <= album.tota_pages; i++) {
         result.push(album.page(i))
    }
-
    -

    Returns number

total_tracks

  • get total_tracks(): number

Methods

fetch

page

  • -

    Spotify Album tracks are divided in pages.

    -

    For example getting data of 51 - 100 videos in a album,

    -
    const album = await play.spotify('album url')

    await album.fetch()

    const result = album.page(2)
-
    -

    Parameters

    • num: number
      -

      Page Number

      -

    Returns undefined | SpotifyTrack[]

toJSON

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.SpotifyPlaylist.html b/docs/classes/_internal_.SpotifyPlaylist.html deleted file mode 100644 index 18e05bd..0000000 --- a/docs/classes/_internal_.SpotifyPlaylist.html +++ /dev/null @@ -1,52 +0,0 @@ -SpotifyPlaylist | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SpotifyPlaylist

-

Spotify Playlist Class

-

Hierarchy

  • SpotifyPlaylist

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

collaborative

collaborative: boolean
-

Spotify Playlist collaborative boolean.

-

description

description: string
-

Spotify Playlist Description

-

Private fetched_tracks

fetched_tracks: <internal>.Map<string, SpotifyTrack[]>
-

Spotify Playlist fetched tracks Map

-

id

id: string
-

Spotify Playlist ID

-

name

name: string
-

Spotify Playlist Name

-

owner

owner: SpotifyArtists
-

Spotify Playlist Owner Artist data

-

Private spotifyData

spotifyData: SpotifyDataOptions
-

Spotify Playlist Spotify data

-

thumbnail

thumbnail: SpotifyThumbnail
-

Spotify Playlist Thumbnail Data

-

tracksCount

tracksCount: number
-

Spotify Playlist total tracks Count

-

type

type: "album" | "playlist" | "track"
-

Spotify Class type. == "playlist"

-

url

url: string
-

Spotify Playlist URL

-

Accessors

total_pages

  • get total_pages(): number
  • -

    Spotify Playlist total no of pages in a playlist

    -

    For getting all songs in a playlist,

    -
    const playlist = await play.spotify('playlist url')

    await playlist.fetch()

    const result = []

    for (let i = 0; i <= playlist.tota_pages; i++) {
         result.push(playlist.page(i))
    }
-
    -

    Returns number

total_tracks

  • get total_tracks(): number

Methods

fetch

page

  • -

    Spotify Playlist tracks are divided in pages.

    -

    For example getting data of 101 - 200 videos in a playlist,

    -
    const playlist = await play.spotify('playlist url')

    await playlist.fetch()

    const result = playlist.page(2)
-
    -

    Parameters

    • num: number
      -

      Page Number

      -

    Returns SpotifyTrack[]

toJSON

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.SpotifyTrack.html b/docs/classes/_internal_.SpotifyTrack.html deleted file mode 100644 index 0811ce3..0000000 --- a/docs/classes/_internal_.SpotifyTrack.html +++ /dev/null @@ -1,26 +0,0 @@ -SpotifyTrack | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SpotifyTrack

-

Spotify Track Class

-

Hierarchy

  • SpotifyTrack

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

album

album: undefined | SpotifyTrackAlbum
-

Spotify Track Album data

-

artists

artists: SpotifyArtists[]
-

Spotify Track Artists data [ array ]

-

durationInMs

durationInMs: number
-

Spotify Track Duration in milli seconds

-

durationInSec

durationInSec: number
-

Spotify Track Duration in seconds

-

explicit

explicit: boolean
-

Spotify Track explicit info.

-

id

id: string
-

Spotify Track ID

-

name

name: string
-

Spotify Track Name

-

thumbnail

thumbnail: undefined | SpotifyThumbnail
-

Spotify Track Thumbnail Data

-

type

type: "album" | "playlist" | "track"
-

Spotify Class type. == "track"

-

url

url: string
-

Spotify Track url

-

Methods

toJSON

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.Stream-1.html b/docs/classes/_internal_.Stream-1.html deleted file mode 100644 index 97a4648..0000000 --- a/docs/classes/_internal_.Stream-1.html +++ /dev/null @@ -1,205 +0,0 @@ -Stream | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Stream

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

addListener

  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Alias for emitter.on(eventName, listener).

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.1.101

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

once

  • once(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.3.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

prependOnceListener

  • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns <internal>.Stream

removeListener

  • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns <internal>.Stream

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.Stream.html b/docs/classes/_internal_.Stream.html deleted file mode 100644 index a67fe2e..0000000 --- a/docs/classes/_internal_.Stream.html +++ /dev/null @@ -1,56 +0,0 @@ -Stream | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Stream

-

YouTube Stream Class for playing audio from normal videos.

-

Hierarchy

  • Stream

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private bytes_count

bytes_count: number
-

Used to calculate no of bytes data that we have recieved

-

Private content_length

content_length: number
-

Total length of audio file in bytes

-

Private per_sec_bytes

per_sec_bytes: number
-

Calculate per second bytes by using contentLength (Total bytes) / Duration (in seconds)

-

Private proxy

proxy: undefined | ProxyOptions[]
-

Proxy config given by user. [ Used only for retrying purposes only. ]

-

Private quality

quality: number
-

Quality given by user. [ Used only for retrying purposes only. ]

-

Private request

request: null | IncomingMessage
-

Incoming message that we recieve.

-

Storing this is essential. -This helps to destroy the TCP connection completely if you stopped player in between the stream

-

stream

stream: <internal>.Readable
-

Readable Stream through which data passes

-

Private timer

timer: <internal>.Timer
-

Timer for looping data every 265 seconds.

-

type

type: StreamType
-

Type of audio data that we recieved from normal youtube url.

-

Private url

url: string
-

Audio Endpoint Format Url to get data from.

-

Private video_url

video_url: string
-

YouTube video url. [ Used only for retrying purposes only. ]

-

Methods

Private cleanup

  • cleanup(): void

Private loop

pause

  • pause(): void

resume

  • resume(): void

Private retry

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.Timer.html b/docs/classes/_internal_.Timer.html deleted file mode 100644 index 78c3687..0000000 --- a/docs/classes/_internal_.Timer.html +++ /dev/null @@ -1,36 +0,0 @@ -Timer | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Timer

-

Timer Class.

-

setTimeout + extra features ( re-starting, pausing, resuming ).

-

Hierarchy

  • Timer

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private callback

callback: () => void

Type declaration

    • (): void
    • -

      Callback to be executed once timer finishes.

      -

      Returns void

Private destroyed

destroyed: boolean
-

Boolean for checking if Timer is destroyed or not.

-

Private paused

paused: boolean
-

Boolean for checking if Timer is paused or not.

-

Private time_left

time_left: number
-

Total time left.

-

Private time_start

time_start: number
-

Seconds time when it is started.

-

Private time_total

time_total: number
-

Total time given by user [ Used only for re-using timer. ]

-

Private timer

timer: <internal>.Timer
-

setTimeout function

-

Methods

destroy

  • destroy(): void

pause

  • pause(): boolean

resume

  • resume(): boolean

reuse

  • reuse(): boolean

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.YouTubeChannel.html b/docs/classes/_internal_.YouTubeChannel.html deleted file mode 100644 index ed4fc4b..0000000 --- a/docs/classes/_internal_.YouTubeChannel.html +++ /dev/null @@ -1,33 +0,0 @@ -YouTubeChannel | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YouTubeChannel

-

YouTube Channel Class

-

Hierarchy

  • YouTubeChannel

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional artist

artist?: boolean
-

YouTube Channel artist if any.

-

Optional icon

icon?: ChannelIconInterface
-

YouTube Channel Icon data.

-

Optional id

id?: string
-

YouTube Channel ID.

-

Optional name

name?: string
-

YouTube Channel Title

-

Optional subscribers

subscribers?: string
-

YouTube Channel subscribers count.

-

type

type: "playlist" | "channel" | "video"
-

YouTube Class type. == "channel"

-

Optional url

url?: string
-

YouTube Channel Url

-

Optional verified

verified?: boolean
-

YouTube Channel Verified status.

-

Methods

iconURL

  • iconURL(options?: { size: number }): undefined | string

toJSON

toString

  • toString(): string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.YouTubePlayList.html b/docs/classes/_internal_.YouTubePlayList.html deleted file mode 100644 index ff5198e..0000000 --- a/docs/classes/_internal_.YouTubePlayList.html +++ /dev/null @@ -1,74 +0,0 @@ -YouTubePlayList | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YouTubePlayList

-

YouTube Playlist Class containing vital informations about playlist.

-

Hierarchy

  • YouTubePlayList

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Private __count

__count: number
-

Total no of pages count.

-

Private _continuation

_continuation: { api?: string; clientVersion?: string; token?: string } = {}
-

Token containing API key, Token, ClientVersion.

-

Type declaration

  • Optional api?: string
  • Optional clientVersion?: string
  • Optional token?: string

Optional channel

channel?: YouTubeChannel
-

YouTube Playlist channel data

-

Private fetched_videos

fetched_videos: <internal>.Map<string, YouTubeVideo[]>
-

Map contaning data of all fetched videos

-

Optional id

id?: string
-

YouTube Playlist ID

-

Optional lastUpdate

lastUpdate?: string
-

Time when playlist was last updated

-

Optional link

link?: string
-

YouTube Playlist url with starting video url.

-

Optional thumbnail

thumbnail?: YouTubeThumbnail
-

YouTube Playlist thumbnail Data

-

Optional title

title?: string
-

YouTube Playlist Name

-

type

type: "playlist" | "channel" | "video"
-

YouTube Class type. == "playlist"

-

Optional url

url?: string
-

YouTube Playlist url

-

Optional videoCount

videoCount?: number
-

Total no of videos in that playlist

-

Private Optional videos

videos?: YouTubeVideo[]
-

Videos array containing data of first 100 videos

-

Optional views

views?: number
-

Total views of that playlist

-

Accessors

total_pages

  • get total_pages(): number
  • -

    Gets total no of pages in that playlist class.

    -

    For getting all songs in a playlist

    -
    const playlist = play.playlist_info('playlist url');

    await playlist.fetch();

    let result = [];

    for (let i = 0; i <= playlist.total_pages;i++) {
         result.push(playlist.page(i));
    }
-
    -

    Returns number

total_videos

  • get total_videos(): number
  • -

    This tells total no of videos that have been fetched so far.

    -

    This can be equal to videosCount if all videos in playlist have been fetched and they are not hidden.

    -

    Returns number

Methods

Private __patch

  • __patch(data: any): void

Private __patchSearch

  • __patchSearch(data: any): void

fetch

next

page

  • -

    YouTube Playlist is divided into pages.

    -

    For example, if you want to get 101 - 200 songs

    -
    const playlist = play.playlist_info('playlist url')

    await playlist.fetch()

    const result = playlist.page(2)
-
    -

    Parameters

    • number: number
      -

      Page number

      -

    Returns YouTubeVideo[]

    Array of YouTube Video Class

    -

toJSON

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.YouTubeThumbnail.html b/docs/classes/_internal_.YouTubeThumbnail.html deleted file mode 100644 index 9e437bb..0000000 --- a/docs/classes/_internal_.YouTubeThumbnail.html +++ /dev/null @@ -1 +0,0 @@ -YouTubeThumbnail | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YouTubeThumbnail

Hierarchy

  • YouTubeThumbnail

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

height

height: number

id

id: string

url

url: string

width

width: number

Methods

toJSON

  • toJSON(): { height: number; id: string; url: string; width: number }

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.YouTubeVideo.html b/docs/classes/_internal_.YouTubeVideo.html deleted file mode 100644 index 8ff3656..0000000 --- a/docs/classes/_internal_.YouTubeVideo.html +++ /dev/null @@ -1,45 +0,0 @@ -YouTubeVideo | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class YouTubeVideo

-

Class for YouTube Video url

-

Hierarchy

  • YouTubeVideo

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Optional channel

channel?: YouTubeChannel
-

YouTube Video's uploader Channel Data

-

Optional description

description?: string
-

YouTube Video description.

-

dislikes

dislikes: number
-

YouTube Video's dislikes

-

durationInSec

durationInSec: number
-

YouTube Video Duration in seconds

-

durationRaw

durationRaw: string
-

YouTube Video Duration Formatted

-

Optional id

id?: string
-

YouTube Video ID

-

likes

likes: number
-

YouTube Video's likes

-

live

live: boolean
-

YouTube Video live status

-

private

private: boolean
-

YouTube Video private status

-

tags

tags: string[]
-

YouTube Video tags

-

Optional thumbnail

thumbnail?: YouTubeThumbnail
-

YouTube Thumbnail Data

-

Optional title

title?: string
-

YouTube Video title

-

type

type: "playlist" | "channel" | "video"
-

YouTube Class type. == "video"

-

Optional uploadedAt

uploadedAt?: string
-

YouTube Video Uploaded Date

-

url

url: string
-

YouTube video url

-

views

views: number
-

YouTube Views

-

Methods

toJSON

toString

  • toString(): string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.internal-1.html b/docs/classes/_internal_.internal-1.html deleted file mode 100644 index f20b6e7..0000000 --- a/docs/classes/_internal_.internal-1.html +++ /dev/null @@ -1,205 +0,0 @@ -internal | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class internal

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

addListener

  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): internal
  • -

    Alias for emitter.on(eventName, listener).

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns internal

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): internal
  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns internal

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): internal
  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.1.101

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns internal

once

  • once(eventName: string | symbol, listener: (...args: any[]) => void): internal
  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.3.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns internal

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): internal
  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns internal

prependOnceListener

  • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): internal
  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns internal

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): internal
  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns internal

removeListener

  • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): internal
  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns internal

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns internal

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.internal.Duplex.html b/docs/classes/_internal_.internal.Duplex.html deleted file mode 100644 index a05cdb8..0000000 --- a/docs/classes/_internal_.internal.Duplex.html +++ /dev/null @@ -1,403 +0,0 @@ -Duplex | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Duplex

-

Duplex streams are streams that implement both the Readable and Writable interfaces.

-

Examples of Duplex streams include:

-
    -
  • TCP sockets
    • -
  • zlib streams
    • -
  • crypto streams
    • -
-
since

v0.9.4

-

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

allowHalfOpen

allowHalfOpen: boolean
-

If false then the stream will automatically end the writable side when the -readable side ends. Set initially by the allowHalfOpen constructor option, -which defaults to false.

-

This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is -emitted.

-
since

v0.9.4

-

destroyed

destroyed: boolean
-

Is true after readable.destroy() has been called.

-
since

v8.0.0

-

readable

readable: boolean
-

Is true if it is safe to call readable.read(), which means -the stream has not been destroyed or emitted 'error' or 'end'.

-
since

v11.4.0

-

Readonly readableAborted

readableAborted: boolean
-

Returns whether the stream was destroyed or errored before emitting 'end'.

-
since

v16.8.0

-
experimental

Readonly readableDidRead

readableDidRead: boolean
-

Returns whether 'data' has been emitted.

-
since

v16.7.0

-
experimental

Readonly readableEncoding

readableEncoding: null | BufferEncoding
-

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

-
since

v12.7.0

-

Readonly readableEnded

readableEnded: boolean
-

Becomes true when 'end' event is emitted.

-
since

v12.9.0

-

Readonly readableFlowing

readableFlowing: null | boolean
-

This property reflects the current state of a Readable stream as described -in the Three states section.

-
since

v9.4.0

-

Readonly readableHighWaterMark

readableHighWaterMark: number
-

Returns the value of highWaterMark passed when creating this Readable.

-
since

v9.3.0

-

Readonly readableLength

readableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be read. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly readableObjectMode

readableObjectMode: boolean
-

Getter for the property objectMode of a given Readable stream.

-
since

v12.3.0

-

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

[asyncIterator]

Optional _construct

_destroy

_final

  • Parameters

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_write

Optional _writev

  • Parameters

    Returns void

addListener

  • -

    Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

cork

  • cork(): void

  • Returns void

destroy

  • -

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable -stream will release any internal resources and subsequent calls to push()will be ignored.

    -

    Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

    -

    Implementors should not override this method, but instead implement readable._destroy().

    -
    since

    v8.0.0

    -

    Parameters

    • Optional error: <internal>.Error
      -

      Error which will be passed as payload in 'error' event

      -

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(cb?: () => void): void
  • end(chunk: any, cb?: () => void): void
  • end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void

  • Parameters

    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

isPaused

  • isPaused(): boolean
  • -

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most -typical cases, there will be no reason to -use this method directly.

    -
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
-
    -
    since

    v0.11.14

    -

    Returns boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

pause

  • -

    The readable.pause() method will cause a stream in flowing mode to stop -emitting 'data' events, switching out of flowing mode. Any data that -becomes available will remain in the internal buffer.

    -
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
      console.log(`Received ${chunk.length} bytes of data.`);
      readable.pause();
      console.log('There will be no additional data for 1 second.');
      setTimeout(() => {
        console.log('Now data will start flowing again.');
        readable.resume();
      }, 1000);
    });
-
    -

    The readable.pause() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns <internal>.internal.Duplex

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

prependOnceListener

  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

push

  • Parameters

    Returns boolean

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

read

  • read(size?: number): any
  • -

    The readable.read() method pulls some data out of the internal buffer and -returns it. If no data available to be read, null is returned. By default, -the data will be returned as a Buffer object unless an encoding has been -specified using the readable.setEncoding() method or the stream is operating -in object mode.

    -

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which -case all of the data remaining in the internal -buffer will be returned.

    -

    If the size argument is not specified, all of the data contained in the -internal buffer will be returned.

    -

    The size argument must be less than or equal to 1 GiB.

    -

    The readable.read() method should only be called on Readable streams -operating in paused mode. In flowing mode, readable.read() is called -automatically until the internal buffer is fully drained.

    -
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
-
    -

    Each call to readable.read() returns a chunk of data, or null. The chunks -are not concatenated. A while loop is necessary to consume all data -currently in the buffer. When reading a large file .read() may return null, -having consumed all buffered content so far, but there is still more data to -come not yet buffered. In this case a new 'readable' event will be emitted -when there is more data in the buffer. Finally the 'end' event will be -emitted when there is no more data to come.

    -

    Therefore to read a file's whole contents from a readable, it is necessary -to collect chunks across multiple 'readable' events:

    -
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
-
    -

    A Readable stream in object mode will always return a single item from -a call to readable.read(size), regardless of the value of thesize argument.

    -

    If the readable.read() method returns a chunk of data, a 'data' event will -also be emitted.

    -

    Calling read after the 'end' event has -been emitted will return null. No runtime error will be raised.

    -
    since

    v0.9.4

    -

    Parameters

    • Optional size: number
      -

      Optional argument to specify how much data to read.

      -

    Returns any

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns <internal>.internal.Duplex

removeListener

  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.internal.Duplex

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.internal.Duplex

resume

  • -

    The readable.resume() method causes an explicitly paused Readable stream to -resume emitting 'data' events, switching the stream into flowing mode.

    -

    The readable.resume() method can be used to fully consume the data from a -stream without actually processing any of that data:

    -
    getReadableStreamSomehow()
      .resume()
      .on('end', () => {
        console.log('Reached the end, but did not read anything.');
      });
-
    -

    The readable.resume() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns <internal>.internal.Duplex

setDefaultEncoding

setEncoding

  • -

    The readable.setEncoding() method sets the character encoding for -data read from the Readable stream.

    -

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data -to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the -output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal -string format.

    -

    The Readable stream will properly handle multi-byte characters delivered -through the stream that would otherwise become improperly decoded if simply -pulled from the stream as Buffer objects.

    -
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
      assert.equal(typeof chunk, 'string');
      console.log('Got %d characters of string data:', chunk.length);
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns <internal>.internal.Duplex

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns <internal>.internal.Duplex

uncork

  • uncork(): void

  • Returns void

unpipe

  • -

    The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

    -

    If the destination is not specified, then all pipes are detached.

    -

    If the destination is specified, but no pipe is set up for it, then -the method does nothing.

    -
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional destination: WritableStream
      -

      Optional specific stream to unpipe

      -

    Returns <internal>.internal.Duplex

unshift

  • -

    Passing chunk as null signals the end of the stream (EOF) and behaves the -same as readable.push(null), after which no more data can be written. The EOF -signal is put at the end of the buffer and any buffered data will still be -flushed.

    -

    The readable.unshift() method pushes a chunk of data back into the internal -buffer. This is useful in certain situations where a stream is being consumed by -code that needs to "un-consume" some amount of data that it has optimistically -pulled out of the source, so that the data can be passed on to some other party.

    -

    The stream.unshift(chunk) method cannot be called after the 'end' event -has been emitted or a runtime error will be thrown.

    -

    Developers using stream.unshift() often should consider switching to -use of a Transform stream instead. See the API for stream implementers section for more information.

    -
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.match(/\n\n/)) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
          } else {
            // Still reading the header.
            header += str;
          }
        }
      }
    }
-
    -

    Unlike push, stream.unshift(chunk) will not -end the reading process by resetting the internal reading state of the stream. -This can cause unexpected results if readable.unshift() is called during a -read (i.e. from within a _read implementation on a -custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, -however it is best to simply avoid calling readable.unshift() while in the -process of performing a read.

    -
    since

    v0.9.11

    -

    Parameters

    • chunk: any
      -

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode -streams, chunk may be any JavaScript value.

      -
    • Optional encoding: BufferEncoding
      -

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      -

    Returns void

wrap

  • -

    Prior to Node.js 0.10, streams did not implement the entire stream module API -as it is currently defined. (See Compatibility for more information.)

    -

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

    -

    It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

    -
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns <internal>.internal.Duplex

write

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

Static from

  • -

    A utility method for creating duplex streams.

    -
      -
    • Stream converts writable stream into writable Duplex and readable stream -to Duplex.
      • -
    • Blob converts into readable Duplex.
      • -
    • string converts into readable Duplex.
      • -
    • ArrayBuffer converts into readable Duplex.
      • -
    • AsyncIterable converts into a readable Duplex. Cannot yield null.
      • -
    • AsyncGeneratorFunction converts into a readable/writable transform -Duplex. Must take a source AsyncIterable as first parameter. Cannot yield -null.
      • -
    • AsyncFunction converts into a writable Duplex. Must return -either null or undefined
      • -
    • Object ({ writable, readable }) converts readable and -writable into Stream and then combines them into Duplex where the -Duplex will write to the writable and read from the readable.
      • -
    • Promise converts into readable Duplex. Value null is ignored.
      • -
    -
    since

    v16.8.0

    -

    Parameters

    Returns <internal>.internal.Duplex

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static isDisturbed

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.internal.PassThrough.html b/docs/classes/_internal_.internal.PassThrough.html deleted file mode 100644 index aa261d9..0000000 --- a/docs/classes/_internal_.internal.PassThrough.html +++ /dev/null @@ -1,397 +0,0 @@ -PassThrough | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PassThrough

-

The stream.PassThrough class is a trivial implementation of a Transform stream that simply passes the input bytes across to the output. Its purpose is -primarily for examples and testing, but there are some use cases wherestream.PassThrough is useful as a building block for novel sorts of streams.

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

allowHalfOpen

allowHalfOpen: boolean
-

If false then the stream will automatically end the writable side when the -readable side ends. Set initially by the allowHalfOpen constructor option, -which defaults to false.

-

This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is -emitted.

-
since

v0.9.4

-

destroyed

destroyed: boolean
-

Is true after readable.destroy() has been called.

-
since

v8.0.0

-

readable

readable: boolean
-

Is true if it is safe to call readable.read(), which means -the stream has not been destroyed or emitted 'error' or 'end'.

-
since

v11.4.0

-

Readonly readableAborted

readableAborted: boolean
-

Returns whether the stream was destroyed or errored before emitting 'end'.

-
since

v16.8.0

-
experimental

Readonly readableDidRead

readableDidRead: boolean
-

Returns whether 'data' has been emitted.

-
since

v16.7.0

-
experimental

Readonly readableEncoding

readableEncoding: null | BufferEncoding
-

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

-
since

v12.7.0

-

Readonly readableEnded

readableEnded: boolean
-

Becomes true when 'end' event is emitted.

-
since

v12.9.0

-

Readonly readableFlowing

readableFlowing: null | boolean
-

This property reflects the current state of a Readable stream as described -in the Three states section.

-
since

v9.4.0

-

Readonly readableHighWaterMark

readableHighWaterMark: number
-

Returns the value of highWaterMark passed when creating this Readable.

-
since

v9.3.0

-

Readonly readableLength

readableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be read. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly readableObjectMode

readableObjectMode: boolean
-

Getter for the property objectMode of a given Readable stream.

-
since

v12.3.0

-

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

[asyncIterator]

Optional _construct

_destroy

_final

_flush

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_transform

_write

Optional _writev

addListener

  • addListener(event: "close", listener: () => void): PassThrough
  • addListener(event: "data", listener: (chunk: any) => void): PassThrough
  • addListener(event: "end", listener: () => void): PassThrough
  • addListener(event: "error", listener: (err: <internal>.Error) => void): PassThrough
  • addListener(event: "pause", listener: () => void): PassThrough
  • addListener(event: "readable", listener: () => void): PassThrough
  • addListener(event: "resume", listener: () => void): PassThrough
  • addListener(event: string | symbol, listener: (...args: any[]) => void): PassThrough
  • -

    Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns PassThrough

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    Returns PassThrough

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PassThrough

cork

  • cork(): void

  • Returns void

destroy

  • -

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable -stream will release any internal resources and subsequent calls to push()will be ignored.

    -

    Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

    -

    Implementors should not override this method, but instead implement readable._destroy().

    -
    since

    v8.0.0

    -

    Parameters

    • Optional error: <internal>.Error
      -

      Error which will be passed as payload in 'error' event

      -

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(cb?: () => void): void
  • end(chunk: any, cb?: () => void): void
  • end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void

  • Parameters

    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

isPaused

  • isPaused(): boolean
  • -

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most -typical cases, there will be no reason to -use this method directly.

    -
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
-
    -
    since

    v0.11.14

    -

    Returns boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): PassThrough
  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PassThrough

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns PassThrough

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    Returns PassThrough

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PassThrough

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns PassThrough

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    Returns PassThrough

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PassThrough

pause

  • -

    The readable.pause() method will cause a stream in flowing mode to stop -emitting 'data' events, switching out of flowing mode. Any data that -becomes available will remain in the internal buffer.

    -
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
      console.log(`Received ${chunk.length} bytes of data.`);
      readable.pause();
      console.log('There will be no additional data for 1 second.');
      setTimeout(() => {
        console.log('Now data will start flowing again.');
        readable.resume();
      }, 1000);
    });
-
    -

    The readable.pause() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns PassThrough

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(event: "close", listener: () => void): PassThrough
  • prependListener(event: "data", listener: (chunk: any) => void): PassThrough
  • prependListener(event: "end", listener: () => void): PassThrough
  • prependListener(event: "error", listener: (err: <internal>.Error) => void): PassThrough
  • prependListener(event: "pause", listener: () => void): PassThrough
  • prependListener(event: "readable", listener: () => void): PassThrough
  • prependListener(event: "resume", listener: () => void): PassThrough
  • prependListener(event: string | symbol, listener: (...args: any[]) => void): PassThrough
  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns PassThrough

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    Returns PassThrough

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PassThrough

prependOnceListener

  • prependOnceListener(event: "close", listener: () => void): PassThrough
  • prependOnceListener(event: "data", listener: (chunk: any) => void): PassThrough
  • prependOnceListener(event: "end", listener: () => void): PassThrough
  • prependOnceListener(event: "error", listener: (err: <internal>.Error) => void): PassThrough
  • prependOnceListener(event: "pause", listener: () => void): PassThrough
  • prependOnceListener(event: "readable", listener: () => void): PassThrough
  • prependOnceListener(event: "resume", listener: () => void): PassThrough
  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): PassThrough
  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns PassThrough

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    Returns PassThrough

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PassThrough

push

  • Parameters

    Returns boolean

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

read

  • read(size?: number): any
  • -

    The readable.read() method pulls some data out of the internal buffer and -returns it. If no data available to be read, null is returned. By default, -the data will be returned as a Buffer object unless an encoding has been -specified using the readable.setEncoding() method or the stream is operating -in object mode.

    -

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which -case all of the data remaining in the internal -buffer will be returned.

    -

    If the size argument is not specified, all of the data contained in the -internal buffer will be returned.

    -

    The size argument must be less than or equal to 1 GiB.

    -

    The readable.read() method should only be called on Readable streams -operating in paused mode. In flowing mode, readable.read() is called -automatically until the internal buffer is fully drained.

    -
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
-
    -

    Each call to readable.read() returns a chunk of data, or null. The chunks -are not concatenated. A while loop is necessary to consume all data -currently in the buffer. When reading a large file .read() may return null, -having consumed all buffered content so far, but there is still more data to -come not yet buffered. In this case a new 'readable' event will be emitted -when there is more data in the buffer. Finally the 'end' event will be -emitted when there is no more data to come.

    -

    Therefore to read a file's whole contents from a readable, it is necessary -to collect chunks across multiple 'readable' events:

    -
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
-
    -

    A Readable stream in object mode will always return a single item from -a call to readable.read(size), regardless of the value of thesize argument.

    -

    If the readable.read() method returns a chunk of data, a 'data' event will -also be emitted.

    -

    Calling read after the 'end' event has -been emitted will return null. No runtime error will be raised.

    -
    since

    v0.9.4

    -

    Parameters

    • Optional size: number
      -

      Optional argument to specify how much data to read.

      -

    Returns any

removeAllListeners

  • removeAllListeners(event?: string | symbol): PassThrough
  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns PassThrough

removeListener

  • removeListener(event: "close", listener: () => void): PassThrough
  • removeListener(event: "data", listener: (chunk: any) => void): PassThrough
  • removeListener(event: "end", listener: () => void): PassThrough
  • removeListener(event: "error", listener: (err: <internal>.Error) => void): PassThrough
  • removeListener(event: "pause", listener: () => void): PassThrough
  • removeListener(event: "readable", listener: () => void): PassThrough
  • removeListener(event: "resume", listener: () => void): PassThrough
  • removeListener(event: string | symbol, listener: (...args: any[]) => void): PassThrough
  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns PassThrough

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    Returns PassThrough

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns PassThrough

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns PassThrough

resume

  • -

    The readable.resume() method causes an explicitly paused Readable stream to -resume emitting 'data' events, switching the stream into flowing mode.

    -

    The readable.resume() method can be used to fully consume the data from a -stream without actually processing any of that data:

    -
    getReadableStreamSomehow()
      .resume()
      .on('end', () => {
        console.log('Reached the end, but did not read anything.');
      });
-
    -

    The readable.resume() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns PassThrough

setDefaultEncoding

setEncoding

  • -

    The readable.setEncoding() method sets the character encoding for -data read from the Readable stream.

    -

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data -to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the -output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal -string format.

    -

    The Readable stream will properly handle multi-byte characters delivered -through the stream that would otherwise become improperly decoded if simply -pulled from the stream as Buffer objects.

    -
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
      assert.equal(typeof chunk, 'string');
      console.log('Got %d characters of string data:', chunk.length);
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns PassThrough

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns PassThrough

uncork

  • uncork(): void

  • Returns void

unpipe

  • -

    The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

    -

    If the destination is not specified, then all pipes are detached.

    -

    If the destination is specified, but no pipe is set up for it, then -the method does nothing.

    -
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional destination: WritableStream
      -

      Optional specific stream to unpipe

      -

    Returns PassThrough

unshift

  • -

    Passing chunk as null signals the end of the stream (EOF) and behaves the -same as readable.push(null), after which no more data can be written. The EOF -signal is put at the end of the buffer and any buffered data will still be -flushed.

    -

    The readable.unshift() method pushes a chunk of data back into the internal -buffer. This is useful in certain situations where a stream is being consumed by -code that needs to "un-consume" some amount of data that it has optimistically -pulled out of the source, so that the data can be passed on to some other party.

    -

    The stream.unshift(chunk) method cannot be called after the 'end' event -has been emitted or a runtime error will be thrown.

    -

    Developers using stream.unshift() often should consider switching to -use of a Transform stream instead. See the API for stream implementers section for more information.

    -
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.match(/\n\n/)) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
          } else {
            // Still reading the header.
            header += str;
          }
        }
      }
    }
-
    -

    Unlike push, stream.unshift(chunk) will not -end the reading process by resetting the internal reading state of the stream. -This can cause unexpected results if readable.unshift() is called during a -read (i.e. from within a _read implementation on a -custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, -however it is best to simply avoid calling readable.unshift() while in the -process of performing a read.

    -
    since

    v0.9.11

    -

    Parameters

    • chunk: any
      -

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode -streams, chunk may be any JavaScript value.

      -
    • Optional encoding: BufferEncoding
      -

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      -

    Returns void

wrap

  • -

    Prior to Node.js 0.10, streams did not implement the entire stream module API -as it is currently defined. (See Compatibility for more information.)

    -

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

    -

    It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

    -
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns PassThrough

write

Static from

  • -

    A utility method for creating duplex streams.

    -
      -
    • Stream converts writable stream into writable Duplex and readable stream -to Duplex.
      • -
    • Blob converts into readable Duplex.
      • -
    • string converts into readable Duplex.
      • -
    • ArrayBuffer converts into readable Duplex.
      • -
    • AsyncIterable converts into a readable Duplex. Cannot yield null.
      • -
    • AsyncGeneratorFunction converts into a readable/writable transform -Duplex. Must take a source AsyncIterable as first parameter. Cannot yield -null.
      • -
    • AsyncFunction converts into a writable Duplex. Must return -either null or undefined
      • -
    • Object ({ writable, readable }) converts readable and -writable into Stream and then combines them into Duplex where the -Duplex will write to the writable and read from the readable.
      • -
    • Promise converts into readable Duplex. Value null is ignored.
      • -
    -
    since

    v16.8.0

    -

    Parameters

    Returns <internal>.internal.Duplex

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static isDisturbed

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.internal.Readable.html b/docs/classes/_internal_.internal.Readable.html deleted file mode 100644 index 367e3c1..0000000 --- a/docs/classes/_internal_.internal.Readable.html +++ /dev/null @@ -1,370 +0,0 @@ -Readable | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Readable

since

v0.9.4

-

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

destroyed

destroyed: boolean
-

Is true after readable.destroy() has been called.

-
since

v8.0.0

-

readable

readable: boolean
-

Is true if it is safe to call readable.read(), which means -the stream has not been destroyed or emitted 'error' or 'end'.

-
since

v11.4.0

-

Readonly readableAborted

readableAborted: boolean
-

Returns whether the stream was destroyed or errored before emitting 'end'.

-
since

v16.8.0

-
experimental

Readonly readableDidRead

readableDidRead: boolean
-

Returns whether 'data' has been emitted.

-
since

v16.7.0

-
experimental

Readonly readableEncoding

readableEncoding: null | BufferEncoding
-

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

-
since

v12.7.0

-

Readonly readableEnded

readableEnded: boolean
-

Becomes true when 'end' event is emitted.

-
since

v12.9.0

-

Readonly readableFlowing

readableFlowing: null | boolean
-

This property reflects the current state of a Readable stream as described -in the Three states section.

-
since

v9.4.0

-

Readonly readableHighWaterMark

readableHighWaterMark: number
-

Returns the value of highWaterMark passed when creating this Readable.

-
since

v9.3.0

-

Readonly readableLength

readableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be read. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly readableObjectMode

readableObjectMode: boolean
-

Getter for the property objectMode of a given Readable stream.

-
since

v12.3.0

-

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

[asyncIterator]

Optional _construct

_destroy

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

addListener

  • -

    Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

destroy

  • -

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable -stream will release any internal resources and subsequent calls to push()will be ignored.

    -

    Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

    -

    Implementors should not override this method, but instead implement readable._destroy().

    -
    since

    v8.0.0

    -

    Parameters

    • Optional error: <internal>.Error
      -

      Error which will be passed as payload in 'error' event

      -

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

isPaused

  • isPaused(): boolean
  • -

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most -typical cases, there will be no reason to -use this method directly.

    -
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
-
    -
    since

    v0.11.14

    -

    Returns boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

pause

  • -

    The readable.pause() method will cause a stream in flowing mode to stop -emitting 'data' events, switching out of flowing mode. Any data that -becomes available will remain in the internal buffer.

    -
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
      console.log(`Received ${chunk.length} bytes of data.`);
      readable.pause();
      console.log('There will be no additional data for 1 second.');
      setTimeout(() => {
        console.log('Now data will start flowing again.');
        readable.resume();
      }, 1000);
    });
-
    -

    The readable.pause() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns <internal>.Readable

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

prependOnceListener

  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

push

  • Parameters

    Returns boolean

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

read

  • read(size?: number): any
  • -

    The readable.read() method pulls some data out of the internal buffer and -returns it. If no data available to be read, null is returned. By default, -the data will be returned as a Buffer object unless an encoding has been -specified using the readable.setEncoding() method or the stream is operating -in object mode.

    -

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which -case all of the data remaining in the internal -buffer will be returned.

    -

    If the size argument is not specified, all of the data contained in the -internal buffer will be returned.

    -

    The size argument must be less than or equal to 1 GiB.

    -

    The readable.read() method should only be called on Readable streams -operating in paused mode. In flowing mode, readable.read() is called -automatically until the internal buffer is fully drained.

    -
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
-
    -

    Each call to readable.read() returns a chunk of data, or null. The chunks -are not concatenated. A while loop is necessary to consume all data -currently in the buffer. When reading a large file .read() may return null, -having consumed all buffered content so far, but there is still more data to -come not yet buffered. In this case a new 'readable' event will be emitted -when there is more data in the buffer. Finally the 'end' event will be -emitted when there is no more data to come.

    -

    Therefore to read a file's whole contents from a readable, it is necessary -to collect chunks across multiple 'readable' events:

    -
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
-
    -

    A Readable stream in object mode will always return a single item from -a call to readable.read(size), regardless of the value of thesize argument.

    -

    If the readable.read() method returns a chunk of data, a 'data' event will -also be emitted.

    -

    Calling read after the 'end' event has -been emitted will return null. No runtime error will be raised.

    -
    since

    v0.9.4

    -

    Parameters

    • Optional size: number
      -

      Optional argument to specify how much data to read.

      -

    Returns any

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns <internal>.Readable

removeListener

  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    Returns <internal>.Readable

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns <internal>.Readable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Readable

resume

  • -

    The readable.resume() method causes an explicitly paused Readable stream to -resume emitting 'data' events, switching the stream into flowing mode.

    -

    The readable.resume() method can be used to fully consume the data from a -stream without actually processing any of that data:

    -
    getReadableStreamSomehow()
      .resume()
      .on('end', () => {
        console.log('Reached the end, but did not read anything.');
      });
-
    -

    The readable.resume() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns <internal>.Readable

setEncoding

  • -

    The readable.setEncoding() method sets the character encoding for -data read from the Readable stream.

    -

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data -to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the -output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal -string format.

    -

    The Readable stream will properly handle multi-byte characters delivered -through the stream that would otherwise become improperly decoded if simply -pulled from the stream as Buffer objects.

    -
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
      assert.equal(typeof chunk, 'string');
      console.log('Got %d characters of string data:', chunk.length);
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns <internal>.Readable

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns <internal>.Readable

unpipe

  • -

    The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

    -

    If the destination is not specified, then all pipes are detached.

    -

    If the destination is specified, but no pipe is set up for it, then -the method does nothing.

    -
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional destination: WritableStream
      -

      Optional specific stream to unpipe

      -

    Returns <internal>.Readable

unshift

  • -

    Passing chunk as null signals the end of the stream (EOF) and behaves the -same as readable.push(null), after which no more data can be written. The EOF -signal is put at the end of the buffer and any buffered data will still be -flushed.

    -

    The readable.unshift() method pushes a chunk of data back into the internal -buffer. This is useful in certain situations where a stream is being consumed by -code that needs to "un-consume" some amount of data that it has optimistically -pulled out of the source, so that the data can be passed on to some other party.

    -

    The stream.unshift(chunk) method cannot be called after the 'end' event -has been emitted or a runtime error will be thrown.

    -

    Developers using stream.unshift() often should consider switching to -use of a Transform stream instead. See the API for stream implementers section for more information.

    -
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.match(/\n\n/)) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
          } else {
            // Still reading the header.
            header += str;
          }
        }
      }
    }
-
    -

    Unlike push, stream.unshift(chunk) will not -end the reading process by resetting the internal reading state of the stream. -This can cause unexpected results if readable.unshift() is called during a -read (i.e. from within a _read implementation on a -custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, -however it is best to simply avoid calling readable.unshift() while in the -process of performing a read.

    -
    since

    v0.9.11

    -

    Parameters

    • chunk: any
      -

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode -streams, chunk may be any JavaScript value.

      -
    • Optional encoding: BufferEncoding
      -

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      -

    Returns void

wrap

  • -

    Prior to Node.js 0.10, streams did not implement the entire stream module API -as it is currently defined. (See Compatibility for more information.)

    -

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

    -

    It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

    -
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns <internal>.Readable

Static from

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static isDisturbed

  • -

    Returns whether the stream has been read from or cancelled.

    -
    since

    v16.8.0

    -

    Parameters

    Returns boolean

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.internal.Stream.html b/docs/classes/_internal_.internal.Stream.html deleted file mode 100644 index c330b30..0000000 --- a/docs/classes/_internal_.internal.Stream.html +++ /dev/null @@ -1,205 +0,0 @@ -Stream | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Stream

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

addListener

  • addListener(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Alias for emitter.on(eventName, listener).

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

on

  • on(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.1.101

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

once

  • once(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.3.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

prependOnceListener

  • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns <internal>.Stream

removeListener

  • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): <internal>.Stream
  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.Stream

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns <internal>.Stream

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.internal.Transform.html b/docs/classes/_internal_.internal.Transform.html deleted file mode 100644 index 4d8f6d4..0000000 --- a/docs/classes/_internal_.internal.Transform.html +++ /dev/null @@ -1,404 +0,0 @@ -Transform | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Transform

-

Transform streams are Duplex streams where the output is in some way -related to the input. Like all Duplex streams, Transform streams -implement both the Readable and Writable interfaces.

-

Examples of Transform streams include:

-
    -
  • zlib streams
    • -
  • crypto streams
    • -
-
since

v0.9.4

-

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

allowHalfOpen

allowHalfOpen: boolean
-

If false then the stream will automatically end the writable side when the -readable side ends. Set initially by the allowHalfOpen constructor option, -which defaults to false.

-

This can be changed manually to change the half-open behavior of an existingDuplex stream instance, but must be changed before the 'end' event is -emitted.

-
since

v0.9.4

-

destroyed

destroyed: boolean
-

Is true after readable.destroy() has been called.

-
since

v8.0.0

-

readable

readable: boolean
-

Is true if it is safe to call readable.read(), which means -the stream has not been destroyed or emitted 'error' or 'end'.

-
since

v11.4.0

-

Readonly readableAborted

readableAborted: boolean
-

Returns whether the stream was destroyed or errored before emitting 'end'.

-
since

v16.8.0

-
experimental

Readonly readableDidRead

readableDidRead: boolean
-

Returns whether 'data' has been emitted.

-
since

v16.7.0

-
experimental

Readonly readableEncoding

readableEncoding: null | BufferEncoding
-

Getter for the property encoding of a given Readable stream. The encodingproperty can be set using the readable.setEncoding() method.

-
since

v12.7.0

-

Readonly readableEnded

readableEnded: boolean
-

Becomes true when 'end' event is emitted.

-
since

v12.9.0

-

Readonly readableFlowing

readableFlowing: null | boolean
-

This property reflects the current state of a Readable stream as described -in the Three states section.

-
since

v9.4.0

-

Readonly readableHighWaterMark

readableHighWaterMark: number
-

Returns the value of highWaterMark passed when creating this Readable.

-
since

v9.3.0

-

Readonly readableLength

readableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be read. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly readableObjectMode

readableObjectMode: boolean
-

Getter for the property objectMode of a given Readable stream.

-
since

v12.3.0

-

Readonly writable

writable: boolean

Readonly writableCorked

writableCorked: number

Readonly writableEnded

writableEnded: boolean

Readonly writableFinished

writableFinished: boolean

Readonly writableHighWaterMark

writableHighWaterMark: number

Readonly writableLength

writableLength: number

Readonly writableObjectMode

writableObjectMode: boolean

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

[asyncIterator]

Optional _construct

_destroy

_final

_flush

  • Parameters

    Returns void

_read

  • _read(size: number): void

  • Parameters

    • size: number

    Returns void

_transform

_write

Optional _writev

addListener

  • addListener(event: "close", listener: () => void): Transform
  • addListener(event: "data", listener: (chunk: any) => void): Transform
  • addListener(event: "end", listener: () => void): Transform
  • addListener(event: "error", listener: (err: <internal>.Error) => void): Transform
  • addListener(event: "pause", listener: () => void): Transform
  • addListener(event: "readable", listener: () => void): Transform
  • addListener(event: "resume", listener: () => void): Transform
  • addListener(event: string | symbol, listener: (...args: any[]) => void): Transform
  • -

    Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. data
      3. -
    3. end
      4. -
    4. error
      5. -
    5. pause
      6. -
    6. readable
      7. -
    7. resume
      8. -
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns Transform

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    Returns Transform

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Transform

cork

  • cork(): void

  • Returns void

destroy

  • -

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the readable -stream will release any internal resources and subsequent calls to push()will be ignored.

    -

    Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

    -

    Implementors should not override this method, but instead implement readable._destroy().

    -
    since

    v8.0.0

    -

    Parameters

    • Optional error: <internal>.Error
      -

      Error which will be passed as payload in 'error' event

      -

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "data", chunk: any): boolean
  • emit(event: "end"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "pause"): boolean
  • emit(event: "readable"): boolean
  • emit(event: "resume"): boolean
  • emit(event: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "data"
    • chunk: any

    Returns boolean

  • Parameters

    • event: "end"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "pause"

    Returns boolean

  • Parameters

    • event: "readable"

    Returns boolean

  • Parameters

    • event: "resume"

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(cb?: () => void): void
  • end(chunk: any, cb?: () => void): void
  • end(chunk: any, encoding?: BufferEncoding, cb?: () => void): void

  • Parameters

    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional encoding: BufferEncoding
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

isPaused

  • isPaused(): boolean
  • -

    The readable.isPaused() method returns the current operating state of theReadable. This is used primarily by the mechanism that underlies thereadable.pipe() method. In most -typical cases, there will be no reason to -use this method directly.

    -
    const readable = new stream.Readable();

    readable.isPaused(); // === false
    readable.pause();
    readable.isPaused(); // === true
    readable.resume();
    readable.isPaused(); // === false
-
    -
    since

    v0.11.14

    -

    Returns boolean

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): Transform
  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Transform

on

  • on(event: "close", listener: () => void): Transform
  • on(event: "data", listener: (chunk: any) => void): Transform
  • on(event: "end", listener: () => void): Transform
  • on(event: "error", listener: (err: <internal>.Error) => void): Transform
  • on(event: "pause", listener: () => void): Transform
  • on(event: "readable", listener: () => void): Transform
  • on(event: "resume", listener: () => void): Transform
  • on(event: string | symbol, listener: (...args: any[]) => void): Transform
  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns Transform

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    Returns Transform

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Transform

once

  • once(event: "close", listener: () => void): Transform
  • once(event: "data", listener: (chunk: any) => void): Transform
  • once(event: "end", listener: () => void): Transform
  • once(event: "error", listener: (err: <internal>.Error) => void): Transform
  • once(event: "pause", listener: () => void): Transform
  • once(event: "readable", listener: () => void): Transform
  • once(event: "resume", listener: () => void): Transform
  • once(event: string | symbol, listener: (...args: any[]) => void): Transform
  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns Transform

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    Returns Transform

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Transform

pause

  • -

    The readable.pause() method will cause a stream in flowing mode to stop -emitting 'data' events, switching out of flowing mode. Any data that -becomes available will remain in the internal buffer.

    -
    const readable = getReadableStreamSomehow();
    readable.on('data', (chunk) => {
      console.log(`Received ${chunk.length} bytes of data.`);
      readable.pause();
      console.log('There will be no additional data for 1 second.');
      setTimeout(() => {
        console.log('Now data will start flowing again.');
        readable.resume();
      }, 1000);
    });
-
    -

    The readable.pause() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns Transform

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • prependListener(event: "close", listener: () => void): Transform
  • prependListener(event: "data", listener: (chunk: any) => void): Transform
  • prependListener(event: "end", listener: () => void): Transform
  • prependListener(event: "error", listener: (err: <internal>.Error) => void): Transform
  • prependListener(event: "pause", listener: () => void): Transform
  • prependListener(event: "readable", listener: () => void): Transform
  • prependListener(event: "resume", listener: () => void): Transform
  • prependListener(event: string | symbol, listener: (...args: any[]) => void): Transform
  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns Transform

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    Returns Transform

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Transform

prependOnceListener

  • prependOnceListener(event: "close", listener: () => void): Transform
  • prependOnceListener(event: "data", listener: (chunk: any) => void): Transform
  • prependOnceListener(event: "end", listener: () => void): Transform
  • prependOnceListener(event: "error", listener: (err: <internal>.Error) => void): Transform
  • prependOnceListener(event: "pause", listener: () => void): Transform
  • prependOnceListener(event: "readable", listener: () => void): Transform
  • prependOnceListener(event: "resume", listener: () => void): Transform
  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Transform
  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns Transform

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    Returns Transform

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Transform

push

  • Parameters

    Returns boolean

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

read

  • read(size?: number): any
  • -

    The readable.read() method pulls some data out of the internal buffer and -returns it. If no data available to be read, null is returned. By default, -the data will be returned as a Buffer object unless an encoding has been -specified using the readable.setEncoding() method or the stream is operating -in object mode.

    -

    The optional size argument specifies a specific number of bytes to read. Ifsize bytes are not available to be read, null will be returned _unless_the stream has ended, in which -case all of the data remaining in the internal -buffer will be returned.

    -

    If the size argument is not specified, all of the data contained in the -internal buffer will be returned.

    -

    The size argument must be less than or equal to 1 GiB.

    -

    The readable.read() method should only be called on Readable streams -operating in paused mode. In flowing mode, readable.read() is called -automatically until the internal buffer is fully drained.

    -
    const readable = getReadableStreamSomehow();

    // 'readable' may be triggered multiple times as data is buffered in
    readable.on('readable', () => {
      let chunk;
      console.log('Stream is readable (new data received in buffer)');
      // Use a loop to make sure we read all currently available data
      while (null !== (chunk = readable.read())) {
        console.log(`Read ${chunk.length} bytes of data...`);
      }
    });

    // 'end' will be triggered once when there is no more data available
    readable.on('end', () => {
      console.log('Reached end of stream.');
    });
-
    -

    Each call to readable.read() returns a chunk of data, or null. The chunks -are not concatenated. A while loop is necessary to consume all data -currently in the buffer. When reading a large file .read() may return null, -having consumed all buffered content so far, but there is still more data to -come not yet buffered. In this case a new 'readable' event will be emitted -when there is more data in the buffer. Finally the 'end' event will be -emitted when there is no more data to come.

    -

    Therefore to read a file's whole contents from a readable, it is necessary -to collect chunks across multiple 'readable' events:

    -
    const chunks = [];

    readable.on('readable', () => {
      let chunk;
      while (null !== (chunk = readable.read())) {
        chunks.push(chunk);
      }
    });

    readable.on('end', () => {
      const content = chunks.join('');
    });
-
    -

    A Readable stream in object mode will always return a single item from -a call to readable.read(size), regardless of the value of thesize argument.

    -

    If the readable.read() method returns a chunk of data, a 'data' event will -also be emitted.

    -

    Calling read after the 'end' event has -been emitted will return null. No runtime error will be raised.

    -
    since

    v0.9.4

    -

    Parameters

    • Optional size: number
      -

      Optional argument to specify how much data to read.

      -

    Returns any

removeAllListeners

  • removeAllListeners(event?: string | symbol): Transform
  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns Transform

removeListener

  • removeListener(event: "close", listener: () => void): Transform
  • removeListener(event: "data", listener: (chunk: any) => void): Transform
  • removeListener(event: "end", listener: () => void): Transform
  • removeListener(event: "error", listener: (err: <internal>.Error) => void): Transform
  • removeListener(event: "pause", listener: () => void): Transform
  • removeListener(event: "readable", listener: () => void): Transform
  • removeListener(event: "resume", listener: () => void): Transform
  • removeListener(event: string | symbol, listener: (...args: any[]) => void): Transform
  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "data"
    • listener: (chunk: any) => void
        • (chunk: any): void

        • Parameters

          • chunk: any

          Returns void

    Returns Transform

  • Parameters

    • event: "end"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    Returns Transform

  • Parameters

    • event: "pause"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "readable"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: "resume"
    • listener: () => void
        • (): void

        • Returns void

    Returns Transform

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Transform

resume

  • -

    The readable.resume() method causes an explicitly paused Readable stream to -resume emitting 'data' events, switching the stream into flowing mode.

    -

    The readable.resume() method can be used to fully consume the data from a -stream without actually processing any of that data:

    -
    getReadableStreamSomehow()
      .resume()
      .on('end', () => {
        console.log('Reached the end, but did not read anything.');
      });
-
    -

    The readable.resume() method has no effect if there is a 'readable'event listener.

    -
    since

    v0.9.4

    -

    Returns Transform

setDefaultEncoding

setEncoding

  • -

    The readable.setEncoding() method sets the character encoding for -data read from the Readable stream.

    -

    By default, no encoding is assigned and stream data will be returned asBuffer objects. Setting an encoding causes the stream data -to be returned as strings of the specified encoding rather than as Bufferobjects. For instance, calling readable.setEncoding('utf8') will cause the -output data to be interpreted as UTF-8 data, and passed as strings. Callingreadable.setEncoding('hex') will cause the data to be encoded in hexadecimal -string format.

    -

    The Readable stream will properly handle multi-byte characters delivered -through the stream that would otherwise become improperly decoded if simply -pulled from the stream as Buffer objects.

    -
    const readable = getReadableStreamSomehow();
    readable.setEncoding('utf8');
    readable.on('data', (chunk) => {
      assert.equal(typeof chunk, 'string');
      console.log('Got %d characters of string data:', chunk.length);
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns Transform

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns Transform

uncork

  • uncork(): void

  • Returns void

unpipe

  • -

    The readable.unpipe() method detaches a Writable stream previously attached -using the pipe method.

    -

    If the destination is not specified, then all pipes are detached.

    -

    If the destination is specified, but no pipe is set up for it, then -the method does nothing.

    -
    const fs = require('fs');
    const readable = getReadableStreamSomehow();
    const writable = fs.createWriteStream('file.txt');
    // All the data from readable goes into 'file.txt',
    // but only for the first second.
    readable.pipe(writable);
    setTimeout(() => {
      console.log('Stop writing to file.txt.');
      readable.unpipe(writable);
      console.log('Manually close the file stream.');
      writable.end();
    }, 1000);
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional destination: WritableStream
      -

      Optional specific stream to unpipe

      -

    Returns Transform

unshift

  • -

    Passing chunk as null signals the end of the stream (EOF) and behaves the -same as readable.push(null), after which no more data can be written. The EOF -signal is put at the end of the buffer and any buffered data will still be -flushed.

    -

    The readable.unshift() method pushes a chunk of data back into the internal -buffer. This is useful in certain situations where a stream is being consumed by -code that needs to "un-consume" some amount of data that it has optimistically -pulled out of the source, so that the data can be passed on to some other party.

    -

    The stream.unshift(chunk) method cannot be called after the 'end' event -has been emitted or a runtime error will be thrown.

    -

    Developers using stream.unshift() often should consider switching to -use of a Transform stream instead. See the API for stream implementers section for more information.

    -
    // Pull off a header delimited by \n\n.
    // Use unshift() if we get too much.
    // Call the callback with (error, header, stream).
    const { StringDecoder } = require('string_decoder');
    function parseHeader(stream, callback) {
      stream.on('error', callback);
      stream.on('readable', onReadable);
      const decoder = new StringDecoder('utf8');
      let header = '';
      function onReadable() {
        let chunk;
        while (null !== (chunk = stream.read())) {
          const str = decoder.write(chunk);
          if (str.match(/\n\n/)) {
            // Found the header boundary.
            const split = str.split(/\n\n/);
            header += split.shift();
            const remaining = split.join('\n\n');
            const buf = Buffer.from(remaining, 'utf8');
            stream.removeListener('error', callback);
            // Remove the 'readable' listener before unshifting.
            stream.removeListener('readable', onReadable);
            if (buf.length)
              stream.unshift(buf);
            // Now the body of the message can be read from the stream.
            callback(null, header, stream);
          } else {
            // Still reading the header.
            header += str;
          }
        }
      }
    }
-
    -

    Unlike push, stream.unshift(chunk) will not -end the reading process by resetting the internal reading state of the stream. -This can cause unexpected results if readable.unshift() is called during a -read (i.e. from within a _read implementation on a -custom stream). Following the call to readable.unshift() with an immediate push will reset the reading state appropriately, -however it is best to simply avoid calling readable.unshift() while in the -process of performing a read.

    -
    since

    v0.9.11

    -

    Parameters

    • chunk: any
      -

      Chunk of data to unshift onto the read queue. For streams not operating in object mode, chunk must be a string, Buffer, Uint8Array or null. For object mode -streams, chunk may be any JavaScript value.

      -
    • Optional encoding: BufferEncoding
      -

      Encoding of string chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'.

      -

    Returns void

wrap

  • -

    Prior to Node.js 0.10, streams did not implement the entire stream module API -as it is currently defined. (See Compatibility for more information.)

    -

    When using an older Node.js library that emits 'data' events and has a pause method that is advisory only, thereadable.wrap() method can be used to create a Readable -stream that uses -the old stream as its data source.

    -

    It will rarely be necessary to use readable.wrap() but the method has been -provided as a convenience for interacting with older Node.js applications and -libraries.

    -
    const { OldReader } = require('./old-api-module.js');
    const { Readable } = require('stream');
    const oreader = new OldReader();
    const myReader = new Readable().wrap(oreader);

    myReader.on('readable', () => {
      myReader.read(); // etc.
    });
-
    -
    since

    v0.9.4

    -

    Parameters

    Returns Transform

write

Static from

  • -

    A utility method for creating duplex streams.

    -
      -
    • Stream converts writable stream into writable Duplex and readable stream -to Duplex.
      • -
    • Blob converts into readable Duplex.
      • -
    • string converts into readable Duplex.
      • -
    • ArrayBuffer converts into readable Duplex.
      • -
    • AsyncIterable converts into a readable Duplex. Cannot yield null.
      • -
    • AsyncGeneratorFunction converts into a readable/writable transform -Duplex. Must take a source AsyncIterable as first parameter. Cannot yield -null.
      • -
    • AsyncFunction converts into a writable Duplex. Must return -either null or undefined
      • -
    • Object ({ writable, readable }) converts readable and -writable into Stream and then combines them into Duplex where the -Duplex will write to the writable and read from the readable.
      • -
    • Promise converts into readable Duplex. Value null is ignored.
      • -
    -
    since

    v16.8.0

    -

    Parameters

    Returns <internal>.internal.Duplex

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static isDisturbed

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/classes/_internal_.internal.Writable.html b/docs/classes/_internal_.internal.Writable.html deleted file mode 100644 index b07900e..0000000 --- a/docs/classes/_internal_.internal.Writable.html +++ /dev/null @@ -1,312 +0,0 @@ -Writable | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Writable

since

v0.9.4

-

Hierarchy

Implements

Implemented by

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

destroyed

destroyed: boolean
-

Is true after writable.destroy() has been called.

-
since

v8.0.0

-

Readonly writable

writable: boolean
-

Is true if it is safe to call writable.write(), which means -the stream has not been destroyed, errored or ended.

-
since

v11.4.0

-

Readonly writableCorked

writableCorked: number
-

Number of times writable.uncork() needs to be -called in order to fully uncork the stream.

-
since

v13.2.0, v12.16.0

-

Readonly writableEnded

writableEnded: boolean
-

Is true after writable.end() has been called. This property -does not indicate whether the data has been flushed, for this use writable.writableFinished instead.

-
since

v12.9.0

-

Readonly writableFinished

writableFinished: boolean
-

Is set to true immediately before the 'finish' event is emitted.

-
since

v12.6.0

-

Readonly writableHighWaterMark

writableHighWaterMark: number
-

Return the value of highWaterMark passed when creating this Writable.

-
since

v9.3.0

-

Readonly writableLength

writableLength: number
-

This property contains the number of bytes (or objects) in the queue -ready to be written. The value provides introspection data regarding -the status of the highWaterMark.

-
since

v9.4.0

-

Readonly writableObjectMode

writableObjectMode: boolean
-

Getter for the property objectMode of a given Writable stream.

-
since

v12.3.0

-

Static Readonly captureRejectionSymbol

captureRejectionSymbol: typeof captureRejectionSymbol

Static captureRejections

captureRejections: boolean
-

Sets or gets the default captureRejection value for all emitters.

-

Static defaultMaxListeners

defaultMaxListeners: number

Static Readonly errorMonitor

errorMonitor: typeof errorMonitor
-

This symbol shall be used to install a listener for only monitoring 'error' -events. Listeners installed using this symbol are called before the regular -'error' listeners are called.

-

Installing a listener using this symbol does not change the behavior once an -'error' event is emitted, therefore the process will still crash if no -regular 'error' listener is installed.

-

Methods

Optional _construct

_destroy

_final

_write

Optional _writev

addListener

  • -

    Event emitter -The defined events on documents including:

    -
      -
    1. close
      2. -
    2. drain
      3. -
    3. error
      4. -
    4. finish
      5. -
    5. pipe
      6. -
    6. unpipe
      7. -
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Writable

cork

  • cork(): void
  • -

    The writable.cork() method forces all written data to be buffered in memory. -The buffered data will be flushed when either the uncork or end methods are called.

    -

    The primary intent of writable.cork() is to accommodate a situation in which -several small chunks are written to the stream in rapid succession. Instead of -immediately forwarding them to the underlying destination, writable.cork()buffers all the chunks until writable.uncork() is called, which will pass them -all to writable._writev(), if present. This prevents a head-of-line blocking -situation where data is being buffered while waiting for the first small chunk -to be processed. However, use of writable.cork() without implementingwritable._writev() may have an adverse effect on throughput.

    -

    See also: writable.uncork(), writable._writev().

    -
    since

    v0.11.2

    -

    Returns void

destroy

  • -

    Destroy the stream. Optionally emit an 'error' event, and emit a 'close'event (unless emitClose is set to false). After this call, the writable -stream has ended and subsequent calls to write() or end() will result in -an ERR_STREAM_DESTROYED error. -This is a destructive and immediate way to destroy a stream. Previous calls towrite() may not have drained, and may trigger an ERR_STREAM_DESTROYED error. -Use end() instead of destroy if data should flush before close, or wait for -the 'drain' event before destroying the stream.

    -

    Once destroy() has been called any further calls will be a no-op and no -further errors except from _destroy() may be emitted as 'error'.

    -

    Implementors should not override this method, -but instead implement writable._destroy().

    -
    since

    v8.0.0

    -

    Parameters

    • Optional error: <internal>.Error
      -

      Optional, an error to emit with 'error' event.

      -

    Returns void

emit

  • emit(event: "close"): boolean
  • emit(event: "drain"): boolean
  • emit(event: "error", err: <internal>.Error): boolean
  • emit(event: "finish"): boolean
  • emit(event: "pipe", src: <internal>.Readable): boolean
  • emit(event: "unpipe", src: <internal>.Readable): boolean
  • emit(event: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -

    Parameters

    • event: "close"

    Returns boolean

  • Parameters

    • event: "drain"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: "finish"

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    Returns boolean

  • Parameters

    • event: string | symbol
    • Rest ...args: any[]

    Returns boolean

end

  • end(cb?: () => void): void
  • end(chunk: any, cb?: () => void): void
  • end(chunk: any, encoding: BufferEncoding, cb?: () => void): void
  • -

    Calling the writable.end() method signals that no more data will be written -to the Writable. The optional chunk and encoding arguments allow one -final additional chunk of data to be written immediately before closing the -stream.

    -

    Calling the write method after calling end will raise an error.

    -
    // Write 'hello, ' and then end with 'world!'.
    const fs = require('fs');
    const file = fs.createWriteStream('example.txt');
    file.write('hello, ');
    file.end('world!');
    // Writing more now is not allowed!
-
    -
    since

    v0.9.4

    -

    Parameters

    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

  • Parameters

    • chunk: any
    • encoding: BufferEncoding
    • Optional cb: () => void
        • (): void

        • Returns void

    Returns void

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • off(eventName: string | symbol, listener: (...args: any[]) => void): Writable
  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Writable

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Writable

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Writable

pipe

  • pipe<T>(destination: T, options?: { end?: boolean }): T

  • Type parameters

    Parameters

    • destination: T
    • Optional options: { end?: boolean }
      • Optional end?: boolean

    Returns T

prependListener

  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Writable

prependOnceListener

  • prependOnceListener(event: "close", listener: () => void): Writable
  • prependOnceListener(event: "drain", listener: () => void): Writable
  • prependOnceListener(event: "error", listener: (err: <internal>.Error) => void): Writable
  • prependOnceListener(event: "finish", listener: () => void): Writable
  • prependOnceListener(event: "pipe", listener: (src: <internal>.Readable) => void): Writable
  • prependOnceListener(event: "unpipe", listener: (src: <internal>.Readable) => void): Writable
  • prependOnceListener(event: string | symbol, listener: (...args: any[]) => void): Writable
  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Writable

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

removeAllListeners

  • removeAllListeners(event?: string | symbol): Writable
  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns Writable

removeListener

  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    Parameters

    • event: "close"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    • event: "drain"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: "finish"
    • listener: () => void
        • (): void

        • Returns void

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    Returns Writable

  • Parameters

    • event: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns Writable

setDefaultEncoding

  • -

    The writable.setDefaultEncoding() method sets the default encoding for a Writable stream.

    -
    since

    v0.11.15

    -

    Parameters

    Returns Writable

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns Writable

uncork

  • uncork(): void
  • -

    The writable.uncork() method flushes all data buffered since cork was called.

    -

    When using writable.cork() and writable.uncork() to manage the buffering -of writes to a stream, it is recommended that calls to writable.uncork() be -deferred using process.nextTick(). Doing so allows batching of allwritable.write() calls that occur within a given Node.js event loop phase.

    -
    stream.cork();
    stream.write('some ');
    stream.write('data ');
    process.nextTick(() => stream.uncork());
-
    -

    If the writable.cork() method is called multiple times on a stream, the -same number of calls to writable.uncork() must be called to flush the buffered -data.

    -
    stream.cork();
    stream.write('some ');
    stream.cork();
    stream.write('data ');
    process.nextTick(() => {
      stream.uncork();
      // The data will not be flushed until uncork() is called a second time.
      stream.uncork();
    });
-
    -

    See also: writable.cork().

    -
    since

    v0.11.2

    -

    Returns void

write

  • -

    The writable.write() method writes some data to the stream, and calls the -supplied callback once the data has been fully handled. If an error -occurs, the callback will be called with the error as its -first argument. The callback is called asynchronously and before 'error' is -emitted.

    -

    The return value is true if the internal buffer is less than thehighWaterMark configured when the stream was created after admitting chunk. -If false is returned, further attempts to write data to the stream should -stop until the 'drain' event is emitted.

    -

    While a stream is not draining, calls to write() will buffer chunk, and -return false. Once all currently buffered chunks are drained (accepted for -delivery by the operating system), the 'drain' event will be emitted. -It is recommended that once write() returns false, no more chunks be written -until the 'drain' event is emitted. While calling write() on a stream that -is not draining is allowed, Node.js will buffer all written chunks until -maximum memory usage occurs, at which point it will abort unconditionally. -Even before it aborts, high memory usage will cause poor garbage collector -performance and high RSS (which is not typically released back to the system, -even after the memory is no longer required). Since TCP sockets may never -drain if the remote peer does not read the data, writing a socket that is -not draining may lead to a remotely exploitable vulnerability.

    -

    Writing data while the stream is not draining is particularly -problematic for a Transform, because the Transform streams are paused -by default until they are piped or a 'data' or 'readable' event handler -is added.

    -

    If the data to be written can be generated or fetched on demand, it is -recommended to encapsulate the logic into a Readable and use pipe. However, if calling write() is preferred, it is -possible to respect backpressure and avoid memory issues using the 'drain' event:

    -
    function write(data, cb) {
      if (!stream.write(data)) {
        stream.once('drain', cb);
      } else {
        process.nextTick(cb);
      }
    }

    // Wait for cb to be called before doing any other write.
    write('hello', () => {
      console.log('Write completed, do more writes now.');
    });
-
    -

    A Writable stream in object mode will always ignore the encoding argument.

    -
    since

    v0.9.4

    -

    Parameters

    • chunk: any
      -

      Optional data to write. For streams not operating in object mode, chunk must be a string, Buffer or Uint8Array. For object mode streams, chunk may be any -JavaScript value other than null.

      -
    • Optional callback: (error: undefined | null | <internal>.Error) => void
      -

      Callback for when this chunk of data is flushed.

      -

    Returns boolean

    false if the stream wishes for the calling code to wait for the 'drain' event to be emitted before continuing to write additional data; otherwise true.

    -

  • Parameters

    Returns boolean

Static getEventListeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -

    For EventEmitters this behaves exactly the same as calling .listeners on -the emitter.

    -

    For EventTargets this is the only way to get the event listeners for the -event target. This is useful for debugging and diagnostic purposes.

    -
    const { getEventListeners, EventEmitter } = require('events');

    {
      const ee = new EventEmitter();
      const listener = () => console.log('Events are fun');
      ee.on('foo', listener);
      getEventListeners(ee, 'foo'); // [listener]
    }
    {
      const et = new EventTarget();
      const listener = () => console.log('Events are fun');
      et.addEventListener('foo', listener);
      getEventListeners(et, 'foo'); // [listener]
    }
-
    -
    since

    v15.2.0

    -

    Parameters

    Returns <internal>.Function[]

Static listenerCount

  • -

    A class method that returns the number of listeners for the given eventNameregistered on the given emitter.

    -
    const { EventEmitter, listenerCount } = require('events');
    const myEmitter = new EventEmitter();
    myEmitter.on('event', () => {});
    myEmitter.on('event', () => {});
    console.log(listenerCount(myEmitter, 'event'));
    // Prints: 2
-
    -
    since

    v0.9.12

    -
    deprecated

    Since v3.2.0 - Use listenerCount instead.

    -

    Parameters

    Returns number

Static on

  • -

    ```js -const { on, EventEmitter } = require('events');

    -

    (async () => { - const ee = new EventEmitter();

    -

    // Emit later on - process.nextTick(() => { - ee.emit('foo', 'bar'); - ee.emit('foo', 42); - });

    -

    for await (const event of on(ee, 'foo')) { - // The execution of this inner block is synchronous and it - // processes one event at a time (even with await). Do not use - // if concurrent execution is required. - console.log(event); // prints ['bar'] [42] - } - // Unreachable here -})();

    -

    Returns an `AsyncIterator` that iterates `eventName` events. It will throw
    if the `EventEmitter` emits `'error'`. It removes all listeners when
    exiting the loop. The `value` returned by each iteration is an array
    composed of the emitted event arguments.

    An `AbortSignal` can be used to cancel waiting on events:

    ```js
    const { on, EventEmitter } = require('events');
    const ac = new AbortController();

    (async () => {
      const ee = new EventEmitter();

      // Emit later on
      process.nextTick(() => {
        ee.emit('foo', 'bar');
        ee.emit('foo', 42);
      });

      for await (const event of on(ee, 'foo', { signal: ac.signal })) {
        // The execution of this inner block is synchronous and it
        // processes one event at a time (even with await). Do not use
        // if concurrent execution is required.
        console.log(event); // prints ['bar'] [42]
      }
      // Unreachable here
    })();

    process.nextTick(() => ac.abort());
-
    -
    since

    v13.6.0, v12.16.0

    -

    Parameters

    Returns AsyncIterableIterator<any>

    that iterates eventName events emitted by the emitter

    -

Static once

  • -

    Creates a Promise that is fulfilled when the EventEmitter emits the given -event or that is rejected if the EventEmitter emits 'error' while waiting. -The Promise will resolve with an array of all the arguments emitted to the -given event.

    -

    This method is intentionally generic and works with the web platform EventTarget interface, which has no special'error' event -semantics and does not listen to the 'error' event.

    -
    const { once, EventEmitter } = require('events');

    async function run() {
      const ee = new EventEmitter();

      process.nextTick(() => {
        ee.emit('myevent', 42);
      });

      const [value] = await once(ee, 'myevent');
      console.log(value);

      const err = new Error('kaboom');
      process.nextTick(() => {
        ee.emit('error', err);
      });

      try {
        await once(ee, 'myevent');
      } catch (err) {
        console.log('error happened', err);
      }
    }

    run();
-
    -

    The special handling of the 'error' event is only used when events.once()is used to wait for another event. If events.once() is used to wait for the -'error' event itself, then it is treated as any other kind of event without -special handling:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();

    once(ee, 'error')
      .then(([err]) => console.log('ok', err.message))
      .catch((err) => console.log('error', err.message));

    ee.emit('error', new Error('boom'));

    // Prints: ok boom
-
    -

    An AbortSignal can be used to cancel waiting for the event:

    -
    const { EventEmitter, once } = require('events');

    const ee = new EventEmitter();
    const ac = new AbortController();

    async function foo(emitter, event, signal) {
      try {
        await once(emitter, event, { signal });
        console.log('event emitted!');
      } catch (error) {
        if (error.name === 'AbortError') {
          console.error('Waiting for the event was canceled!');
        } else {
          console.error('There was an error', error.message);
        }
      }
    }

    foo(ee, 'foo', ac.signal);
    ac.abort(); // Abort waiting for the event
    ee.emit('foo'); // Prints: Waiting for the event was canceled!
-
    -
    since

    v11.13.0, v10.16.0

    -

    Parameters

    Returns <internal>.Promise<any[]>

  • Parameters

    Returns <internal>.Promise<any[]>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/enums/_internal_.StreamType.html b/docs/enums/_internal_.StreamType.html deleted file mode 100644 index c661ceb..0000000 --- a/docs/enums/_internal_.StreamType.html +++ /dev/null @@ -1 +0,0 @@ -StreamType | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Enumeration StreamType

Index

Enumeration members

Enumeration members

Arbitrary

Arbitrary = "arbitrary"

OggOpus

OggOpus = "ogg/opus"

Opus

Opus = "opus"

Raw

Raw = "raw"

WebmOpus

WebmOpus = "webm/opus"

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/index.html b/docs/index.html deleted file mode 100644 index 7b2f942..0000000 --- a/docs/index.html +++ /dev/null @@ -1,62 +0,0 @@ -play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

play-dl

- -

Why play-dl ?

- -

ytdl-core has some issues with miniget and also stream abort issues. On the other hand, youtube-dl is a very perfect alternative but it takes time to launch. Hence, play-dl is created to avoid these issues along with providing comparatively faster performance than others.

-

Discord

- - -

Support

- -

You can contact us for support on our chat server

- - -

Stream videos/playlists or search for videos

- -

This is a light-weight youtube downloader and searcher.

-
    -
  • searches by video, playlist, channel
    • -
  • obtains audio playback url
    • -
- - -

Installation

- -
npm install play-dl@latest
-
- - -

Importing

- -
import * as play from 'play-dl' // ES-6 import or TS import

const play = require('play-dl') //JS importing
-
- - -

Instructions

- -
    -
  • 1.0 release change brings some code changes, make sure to read docs once again.
    • -
  • Spotify
    • -
  • SoundCloud
    • -
- - -

Examples

- - - - -

Docs

- - -

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.AbortSignal.html b/docs/interfaces/_internal_.AbortSignal.html deleted file mode 100644 index 6f553c9..0000000 --- a/docs/interfaces/_internal_.AbortSignal.html +++ /dev/null @@ -1,5 +0,0 @@ -AbortSignal | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AbortSignal

-

A signal object that allows you to communicate with a DOM request (such as a Fetch) and abort it if required via an AbortController object.

-

Hierarchy

  • AbortSignal

Index

Properties

Properties

Readonly aborted

aborted: boolean
-

Returns true if this AbortSignal's AbortController has signaled to abort, and false otherwise.

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.AddressInfo.html b/docs/interfaces/_internal_.AddressInfo.html deleted file mode 100644 index 42261b1..0000000 --- a/docs/interfaces/_internal_.AddressInfo.html +++ /dev/null @@ -1 +0,0 @@ -AddressInfo | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AddressInfo

Hierarchy

  • AddressInfo

Index

Properties

Properties

address

address: string

family

family: string

port

port: number

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.AlbumJSON.html b/docs/interfaces/_internal_.AlbumJSON.html deleted file mode 100644 index c2a0e68..0000000 --- a/docs/interfaces/_internal_.AlbumJSON.html +++ /dev/null @@ -1,21 +0,0 @@ -AlbumJSON | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AlbumJSON

Hierarchy

  • AlbumJSON

Index

Properties

Properties

artists

artists: SpotifyArtists[]
-

Spotify Album artists [ array ]

-

copyrights

copyrights: SpotifyCopyright[]
-

Spotify Album copyright data [ array ]

-

id

id: string
-

Spotify Album id

-

name

name: string
-

Spotify Album Name

-

release_date

release_date: string
-

Spotify Album Release date

-

release_date_precision

release_date_precision: string
-

Spotify Album Release Date precise

-

thumbnail

thumbnail: SpotifyThumbnail
-

Spotify Album Thumbnail data

-

tracksCount

tracksCount: number
-

Spotify Album total no of tracks

-

type

type: "album" | "playlist" | "track"
-

Spotify Class type. == "album"

-

url

url: string
-

Spotify Album url

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ArrayBuffer.html b/docs/interfaces/_internal_.ArrayBuffer.html deleted file mode 100644 index 65921b3..0000000 --- a/docs/interfaces/_internal_.ArrayBuffer.html +++ /dev/null @@ -1,10 +0,0 @@ -ArrayBuffer | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ArrayBuffer

-

Represents a raw buffer of binary data, which is used to store data for the -different typed arrays. ArrayBuffers cannot be read from or written to directly, -but can be passed to a typed array or DataView Object to interpret the raw -buffer as needed.

-

Hierarchy

  • ArrayBuffer

Index

Properties

Methods

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly byteLength

byteLength: number
-

Read-only. The length of the ArrayBuffer (in bytes).

-

Methods

slice

  • -

    Returns a section of an ArrayBuffer.

    -

    Parameters

    • begin: number
    • Optional end: number

    Returns <internal>.ArrayBuffer

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ArrayBufferConstructor.html b/docs/interfaces/_internal_.ArrayBufferConstructor.html deleted file mode 100644 index 9b387a6..0000000 --- a/docs/interfaces/_internal_.ArrayBufferConstructor.html +++ /dev/null @@ -1 +0,0 @@ -ArrayBufferConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ArrayBufferConstructor

Hierarchy

  • ArrayBufferConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • byteLength: number

    Returns <internal>.ArrayBuffer

Properties

Readonly [species]

[species]: ArrayBufferConstructor

Readonly prototype

prototype: <internal>.ArrayBuffer

Methods

isView

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ArrayBufferTypes.html b/docs/interfaces/_internal_.ArrayBufferTypes.html deleted file mode 100644 index bb5c1ef..0000000 --- a/docs/interfaces/_internal_.ArrayBufferTypes.html +++ /dev/null @@ -1,3 +0,0 @@ -ArrayBufferTypes | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ArrayBufferTypes

-

Allowed ArrayBuffer types for the buffer of an ArrayBufferView and related Typed Arrays.

-

Hierarchy

  • ArrayBufferTypes

Index

Properties

Properties

ArrayBuffer

ArrayBuffer: <internal>.ArrayBuffer

SharedArrayBuffer

SharedArrayBuffer: <internal>.SharedArrayBuffer

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ArrayBufferView.html b/docs/interfaces/_internal_.ArrayBufferView.html deleted file mode 100644 index 12796bc..0000000 --- a/docs/interfaces/_internal_.ArrayBufferView.html +++ /dev/null @@ -1,7 +0,0 @@ -ArrayBufferView | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ArrayBufferView

Hierarchy

  • ArrayBufferView

Index

Properties

Properties

buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

byteLength

byteLength: number
-

The length in bytes of the array.

-

byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ArrayLike.html b/docs/interfaces/_internal_.ArrayLike.html deleted file mode 100644 index 2853f04..0000000 --- a/docs/interfaces/_internal_.ArrayLike.html +++ /dev/null @@ -1 +0,0 @@ -ArrayLike | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ArrayLike<T>

Type parameters

  • T

Hierarchy

  • ArrayLike

Indexable

[n: number]: T

Index

Properties

Properties

Readonly length

length: number

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.AsyncGenerator.html b/docs/interfaces/_internal_.AsyncGenerator.html deleted file mode 100644 index 993ca9b..0000000 --- a/docs/interfaces/_internal_.AsyncGenerator.html +++ /dev/null @@ -1 +0,0 @@ -AsyncGenerator | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncGenerator<T, TReturn, TNext>

Type parameters

  • T = unknown

  • TReturn = any

  • TNext = unknown

Hierarchy

Index

Methods

Methods

[asyncIterator]

  • Returns AsyncGenerator<T, TReturn, TNext>

next

return

throw

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.AsyncGeneratorFunction.html b/docs/interfaces/_internal_.AsyncGeneratorFunction.html deleted file mode 100644 index 4a9961c..0000000 --- a/docs/interfaces/_internal_.AsyncGeneratorFunction.html +++ /dev/null @@ -1,15 +0,0 @@ -AsyncGeneratorFunction | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncGeneratorFunction

Hierarchy

  • AsyncGeneratorFunction

Callable

  • AsyncGeneratorFunction(...args: any[]): AsyncGenerator<unknown, any, unknown>
  • -

    Creates a new AsyncGenerator object.

    -

    Parameters

    • Rest ...args: any[]
      -

      A list of arguments the function accepts.

      -

    Returns AsyncGenerator<unknown, any, unknown>

Index

Constructors

Properties

Constructors

constructor

  • new AsyncGeneratorFunction(...args: any[]): AsyncGenerator<unknown, any, unknown>
  • -

    Creates a new AsyncGenerator object.

    -

    Parameters

    • Rest ...args: any[]
      -

      A list of arguments the function accepts.

      -

    Returns AsyncGenerator<unknown, any, unknown>

Properties

Readonly length

length: number
-

The length of the arguments.

-

Readonly name

name: string
-

Returns the name of the function.

-

Readonly prototype

prototype: AsyncGenerator<unknown, any, unknown>
-

A reference to the prototype.

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.AsyncIterable.html b/docs/interfaces/_internal_.AsyncIterable.html deleted file mode 100644 index 1de0716..0000000 --- a/docs/interfaces/_internal_.AsyncIterable.html +++ /dev/null @@ -1 +0,0 @@ -AsyncIterable | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncIterable<T>

Type parameters

  • T

Hierarchy

  • AsyncIterable

Index

Methods

Methods

[asyncIterator]

  • Returns AsyncIterator<T, any, undefined>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.AsyncIterableIterator.html b/docs/interfaces/_internal_.AsyncIterableIterator.html deleted file mode 100644 index 12d5184..0000000 --- a/docs/interfaces/_internal_.AsyncIterableIterator.html +++ /dev/null @@ -1 +0,0 @@ -AsyncIterableIterator | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncIterableIterator<T>

Type parameters

  • T

Hierarchy

Index

Methods

Methods

[asyncIterator]

next

Optional return

Optional throw

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.AsyncIterator.html b/docs/interfaces/_internal_.AsyncIterator.html deleted file mode 100644 index 56fe8b5..0000000 --- a/docs/interfaces/_internal_.AsyncIterator.html +++ /dev/null @@ -1 +0,0 @@ -AsyncIterator | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface AsyncIterator<T, TReturn, TNext>

Type parameters

  • T

  • TReturn = any

  • TNext = undefined

Hierarchy

Index

Methods

Methods

next

  • Parameters

    • Rest ...args: [] | [TNext]

    Returns <internal>.Promise<IteratorResult<T, TReturn>>

Optional return

Optional throw

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.BigInt64Array.html b/docs/interfaces/_internal_.BigInt64Array.html deleted file mode 100644 index d2a3176..0000000 --- a/docs/interfaces/_internal_.BigInt64Array.html +++ /dev/null @@ -1,200 +0,0 @@ -BigInt64Array | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BigInt64Array

-

A typed array of 64-bit signed integer values. The contents are initialized to 0. If the -requested number of bytes could not be allocated, an exception is raised.

-

Hierarchy

Indexable

[index: number]: bigint

Index

Properties

Methods

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "BigInt64Array"

Readonly buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number
-

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Readonly length

length: number
-

The length of the array.

-

Methods

[iterator]

  • Returns IterableIterator<bigint>

at

  • at(index: number): undefined | bigint
  • -

    Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | bigint

copyWithin

  • -

    Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

    -

    Parameters

    • target: number
      -

      If target is negative, it is treated as length+target where length is the -length of the array.

      -
    • start: number
      -

      If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

      -
    • Optional end: number
      -

      If not specified, length of the this object is used as its default value.

      -

    Returns <internal>.BigInt64Array

entries

  • -

    Yields index, value pairs for every entry in the array.

    -

    Returns IterableIterator<[number, bigint]>

every

  • every(predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => boolean, thisArg?: any): boolean
  • -

    Determines whether all the members of an array satisfy the specified test.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => boolean
      -

      A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns false, -or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

fill

  • -

    Changes all array elements from start to end index to a static value and returns the modified array

    -

    Parameters

    • value: bigint
      -

      value to fill array section with

      -
    • Optional start: number
      -

      index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

      -
    • Optional end: number
      -

      index to stop filling the array at. If end is negative, it is treated as -length+end.

      -

    Returns <internal>.BigInt64Array

filter

  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => any
      -

      A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.BigInt64Array

find

  • find(predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => boolean, thisArg?: any): undefined | bigint
  • -

    Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns undefined | bigint

findIndex

  • findIndex(predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => boolean, thisArg?: any): number
  • -

    Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns number

forEach

  • -

    Performs the specified action for each element in an array.

    -

    Parameters

    • callbackfn: (value: bigint, index: number, array: <internal>.BigInt64Array) => void
      -

      A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns void

includes

  • includes(searchElement: bigint, fromIndex?: number): boolean
  • -

    Determines whether an array includes a certain element, returning true or false as appropriate.

    -

    Parameters

    • searchElement: bigint
      -

      The element to search for.

      -
    • Optional fromIndex: number
      -

      The position in this array at which to begin searching for searchElement.

      -

    Returns boolean

indexOf

  • indexOf(searchElement: bigint, fromIndex?: number): number
  • -

    Returns the index of the first occurrence of a value in an array.

    -

    Parameters

    • searchElement: bigint
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

join

  • join(separator?: string): string
  • -

    Adds all the elements of an array separated by the specified separator string.

    -

    Parameters

    • Optional separator: string
      -

      A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

      -

    Returns string

keys

  • -

    Yields each index in the array.

    -

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: bigint, fromIndex?: number): number
  • -

    Returns the index of the last occurrence of a value in an array.

    -

    Parameters

    • searchElement: bigint
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

map

  • -

    Calls a defined callback function on each element of an array, and returns an array that -contains the results.

    -

    Parameters

    • callbackfn: (value: bigint, index: number, array: <internal>.BigInt64Array) => bigint
      -

      A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.BigInt64Array

reduce

  • reduce(callbackfn: (previousValue: bigint, currentValue: bigint, currentIndex: number, array: <internal>.BigInt64Array) => bigint): bigint
  • reduce<U>(callbackfn: (previousValue: U, currentValue: bigint, currentIndex: number, array: <internal>.BigInt64Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: bigint, currentValue: bigint, currentIndex: number, array: <internal>.BigInt64Array) => bigint
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -

    Returns bigint

  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: bigint, currentIndex: number, array: <internal>.BigInt64Array) => U
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: bigint, currentValue: bigint, currentIndex: number, array: <internal>.BigInt64Array) => bigint): bigint
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: bigint, currentIndex: number, array: <internal>.BigInt64Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: bigint, currentValue: bigint, currentIndex: number, array: <internal>.BigInt64Array) => bigint
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -

    Returns bigint

  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: bigint, currentIndex: number, array: <internal>.BigInt64Array) => U
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reverse

  • -

    Reverses the elements in the array.

    -

    Returns <internal>.BigInt64Array

set

  • set(array: ArrayLike<bigint>, offset?: number): void
  • -

    Sets a value or an array of values.

    -

    Parameters

    • array: ArrayLike<bigint>
      -

      A typed or untyped array of values to set.

      -
    • Optional offset: number
      -

      The index in the current array at which the values are to be written.

      -

    Returns void

slice

  • -

    Returns a section of an array.

    -

    Parameters

    • Optional start: number
      -

      The beginning of the specified portion of the array.

      -
    • Optional end: number
      -

      The end of the specified portion of the array.

      -

    Returns <internal>.BigInt64Array

some

  • some(predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => boolean, thisArg?: any): boolean
  • -

    Determines whether the specified callback function returns true for any element of an array.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigInt64Array) => boolean
      -

      A function that accepts up to three arguments. The some method calls the -predicate function for each element in the array until the predicate returns true, or until -the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

sort

  • -

    Sorts the array.

    -

    Parameters

    • Optional compareFn: (a: bigint, b: bigint) => number | bigint
      -

      The function used to determine the order of the elements. If omitted, the elements are sorted in ascending order.

      -
        • (a: bigint, b: bigint): number | bigint

        • Parameters

          • a: bigint
          • b: bigint

          Returns number | bigint

    Returns <internal>.BigInt64Array

subarray

  • -

    Gets a new BigInt64Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

    -

    Parameters

    • Optional begin: number
      -

      The index of the beginning of the array.

      -
    • Optional end: number
      -

      The index of the end of the array.

      -

    Returns <internal>.BigInt64Array

toLocaleString

  • toLocaleString(): string
  • -

    Converts the array to a string by using the current locale.

    -

    Returns string

toString

  • toString(): string
  • -

    Returns a string representation of the array.

    -

    Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.BigInt64Array

values

  • -

    Yields each value in the array.

    -

    Returns IterableIterator<bigint>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.BigInt64ArrayConstructor.html b/docs/interfaces/_internal_.BigInt64ArrayConstructor.html deleted file mode 100644 index 288332c..0000000 --- a/docs/interfaces/_internal_.BigInt64ArrayConstructor.html +++ /dev/null @@ -1,11 +0,0 @@ -BigInt64ArrayConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BigInt64ArrayConstructor

Hierarchy

  • BigInt64ArrayConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly prototype

prototype: <internal>.BigInt64Array

Methods

from

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: ArrayLike<bigint>
      -

      An array-like or iterable object to convert to an array.

      -

    Returns <internal>.BigInt64Array

  • Type parameters

    • U

    Parameters

    • arrayLike: ArrayLike<U>
    • mapfn: (v: U, k: number) => bigint
        • (v: U, k: number): bigint

        • Parameters

          • v: U
          • k: number

          Returns bigint

    • Optional thisArg: any

    Returns <internal>.BigInt64Array

of

  • -

    Returns a new array from a set of elements.

    -

    Parameters

    • Rest ...items: bigint[]
      -

      A set of elements to include in the new array object.

      -

    Returns <internal>.BigInt64Array

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.BigUint64Array.html b/docs/interfaces/_internal_.BigUint64Array.html deleted file mode 100644 index 1d8d2fb..0000000 --- a/docs/interfaces/_internal_.BigUint64Array.html +++ /dev/null @@ -1,200 +0,0 @@ -BigUint64Array | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BigUint64Array

-

A typed array of 64-bit unsigned integer values. The contents are initialized to 0. If the -requested number of bytes could not be allocated, an exception is raised.

-

Hierarchy

Indexable

[index: number]: bigint

Index

Properties

Methods

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "BigUint64Array"

Readonly buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number
-

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Readonly length

length: number
-

The length of the array.

-

Methods

[iterator]

  • Returns IterableIterator<bigint>

at

  • at(index: number): undefined | bigint
  • -

    Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | bigint

copyWithin

  • -

    Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

    -

    Parameters

    • target: number
      -

      If target is negative, it is treated as length+target where length is the -length of the array.

      -
    • start: number
      -

      If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

      -
    • Optional end: number
      -

      If not specified, length of the this object is used as its default value.

      -

    Returns <internal>.BigUint64Array

entries

  • -

    Yields index, value pairs for every entry in the array.

    -

    Returns IterableIterator<[number, bigint]>

every

  • -

    Determines whether all the members of an array satisfy the specified test.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigUint64Array) => boolean
      -

      A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns false, -or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

fill

  • -

    Changes all array elements from start to end index to a static value and returns the modified array

    -

    Parameters

    • value: bigint
      -

      value to fill array section with

      -
    • Optional start: number
      -

      index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

      -
    • Optional end: number
      -

      index to stop filling the array at. If end is negative, it is treated as -length+end.

      -

    Returns <internal>.BigUint64Array

filter

  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigUint64Array) => any
      -

      A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.BigUint64Array

find

  • find(predicate: (value: bigint, index: number, array: <internal>.BigUint64Array) => boolean, thisArg?: any): undefined | bigint
  • -

    Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigUint64Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns undefined | bigint

findIndex

  • findIndex(predicate: (value: bigint, index: number, array: <internal>.BigUint64Array) => boolean, thisArg?: any): number
  • -

    Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigUint64Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns number

forEach

  • -

    Performs the specified action for each element in an array.

    -

    Parameters

    • callbackfn: (value: bigint, index: number, array: <internal>.BigUint64Array) => void
      -

      A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns void

includes

  • includes(searchElement: bigint, fromIndex?: number): boolean
  • -

    Determines whether an array includes a certain element, returning true or false as appropriate.

    -

    Parameters

    • searchElement: bigint
      -

      The element to search for.

      -
    • Optional fromIndex: number
      -

      The position in this array at which to begin searching for searchElement.

      -

    Returns boolean

indexOf

  • indexOf(searchElement: bigint, fromIndex?: number): number
  • -

    Returns the index of the first occurrence of a value in an array.

    -

    Parameters

    • searchElement: bigint
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

join

  • join(separator?: string): string
  • -

    Adds all the elements of an array separated by the specified separator string.

    -

    Parameters

    • Optional separator: string
      -

      A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

      -

    Returns string

keys

  • -

    Yields each index in the array.

    -

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: bigint, fromIndex?: number): number
  • -

    Returns the index of the last occurrence of a value in an array.

    -

    Parameters

    • searchElement: bigint
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

map

  • -

    Calls a defined callback function on each element of an array, and returns an array that -contains the results.

    -

    Parameters

    • callbackfn: (value: bigint, index: number, array: <internal>.BigUint64Array) => bigint
      -

      A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.BigUint64Array

reduce

  • reduce(callbackfn: (previousValue: bigint, currentValue: bigint, currentIndex: number, array: <internal>.BigUint64Array) => bigint): bigint
  • reduce<U>(callbackfn: (previousValue: U, currentValue: bigint, currentIndex: number, array: <internal>.BigUint64Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: bigint, currentValue: bigint, currentIndex: number, array: <internal>.BigUint64Array) => bigint
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -

    Returns bigint

  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: bigint, currentIndex: number, array: <internal>.BigUint64Array) => U
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: bigint, currentValue: bigint, currentIndex: number, array: <internal>.BigUint64Array) => bigint): bigint
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: bigint, currentIndex: number, array: <internal>.BigUint64Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: bigint, currentValue: bigint, currentIndex: number, array: <internal>.BigUint64Array) => bigint
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -

    Returns bigint

  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: bigint, currentIndex: number, array: <internal>.BigUint64Array) => U
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reverse

  • -

    Reverses the elements in the array.

    -

    Returns <internal>.BigUint64Array

set

  • set(array: ArrayLike<bigint>, offset?: number): void
  • -

    Sets a value or an array of values.

    -

    Parameters

    • array: ArrayLike<bigint>
      -

      A typed or untyped array of values to set.

      -
    • Optional offset: number
      -

      The index in the current array at which the values are to be written.

      -

    Returns void

slice

  • -

    Returns a section of an array.

    -

    Parameters

    • Optional start: number
      -

      The beginning of the specified portion of the array.

      -
    • Optional end: number
      -

      The end of the specified portion of the array.

      -

    Returns <internal>.BigUint64Array

some

  • -

    Determines whether the specified callback function returns true for any element of an array.

    -

    Parameters

    • predicate: (value: bigint, index: number, array: <internal>.BigUint64Array) => boolean
      -

      A function that accepts up to three arguments. The some method calls the -predicate function for each element in the array until the predicate returns true, or until -the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

sort

  • -

    Sorts the array.

    -

    Parameters

    • Optional compareFn: (a: bigint, b: bigint) => number | bigint
      -

      The function used to determine the order of the elements. If omitted, the elements are sorted in ascending order.

      -
        • (a: bigint, b: bigint): number | bigint

        • Parameters

          • a: bigint
          • b: bigint

          Returns number | bigint

    Returns <internal>.BigUint64Array

subarray

  • -

    Gets a new BigUint64Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

    -

    Parameters

    • Optional begin: number
      -

      The index of the beginning of the array.

      -
    • Optional end: number
      -

      The index of the end of the array.

      -

    Returns <internal>.BigUint64Array

toLocaleString

  • toLocaleString(): string
  • -

    Converts the array to a string by using the current locale.

    -

    Returns string

toString

  • toString(): string
  • -

    Returns a string representation of the array.

    -

    Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.BigUint64Array

values

  • -

    Yields each value in the array.

    -

    Returns IterableIterator<bigint>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.BigUint64ArrayConstructor.html b/docs/interfaces/_internal_.BigUint64ArrayConstructor.html deleted file mode 100644 index ca66bab..0000000 --- a/docs/interfaces/_internal_.BigUint64ArrayConstructor.html +++ /dev/null @@ -1,11 +0,0 @@ -BigUint64ArrayConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BigUint64ArrayConstructor

Hierarchy

  • BigUint64ArrayConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly prototype

prototype: <internal>.BigUint64Array

Methods

from

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: ArrayLike<bigint>
      -

      An array-like or iterable object to convert to an array.

      -

    Returns <internal>.BigUint64Array

  • Type parameters

    • U

    Parameters

    • arrayLike: ArrayLike<U>
    • mapfn: (v: U, k: number) => bigint
        • (v: U, k: number): bigint

        • Parameters

          • v: U
          • k: number

          Returns bigint

    • Optional thisArg: any

    Returns <internal>.BigUint64Array

of

  • -

    Returns a new array from a set of elements.

    -

    Parameters

    • Rest ...items: bigint[]
      -

      A set of elements to include in the new array object.

      -

    Returns <internal>.BigUint64Array

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Blob.html b/docs/interfaces/_internal_.Blob.html deleted file mode 100644 index 5b04670..0000000 --- a/docs/interfaces/_internal_.Blob.html +++ /dev/null @@ -1 +0,0 @@ -Blob | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Blob

Hierarchy

  • Blob

Index

Properties

Methods

Properties

Readonly size

size: number

Readonly type

type: string

Methods

arrayBuffer

slice

  • slice(start?: number, end?: number, contentType?: string): Blob

  • Parameters

    • Optional start: number
    • Optional end: number
    • Optional contentType: string

    Returns Blob

stream

  • Returns ReadableStream

text

  • Returns <internal>.Promise<string>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Buffer.html b/docs/interfaces/_internal_.Buffer.html deleted file mode 100644 index 4cdde44..0000000 --- a/docs/interfaces/_internal_.Buffer.html +++ /dev/null @@ -1,718 +0,0 @@ -Buffer | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Buffer

Hierarchy

Index

Properties

Methods

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "Uint8Array"

Readonly buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number
-

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Readonly length

length: number
-

The length of the array.

-

Methods

[iterator]

  • Returns IterableIterator<number>

at

  • at(index: number): undefined | number
  • -

    Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | number

compare

  • compare(target: <internal>.Uint8Array, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number
  • -

    Compares buf with target and returns a number indicating whether bufcomes before, after, or is the same as target in sort order. -Comparison is based on the actual sequence of bytes in each Buffer.

    -
      -
    • 0 is returned if target is the same as buf
      • -
    • 1 is returned if target should come beforebuf when sorted.
      • -
    • -1 is returned if target should come afterbuf when sorted.
      • -
    -
    import { Buffer } from 'buffer';

    const buf1 = Buffer.from('ABC');
    const buf2 = Buffer.from('BCD');
    const buf3 = Buffer.from('ABCD');

    console.log(buf1.compare(buf1));
    // Prints: 0
    console.log(buf1.compare(buf2));
    // Prints: -1
    console.log(buf1.compare(buf3));
    // Prints: -1
    console.log(buf2.compare(buf1));
    // Prints: 1
    console.log(buf2.compare(buf3));
    // Prints: 1
    console.log([buf1, buf2, buf3].sort(Buffer.compare));
    // Prints: [ <Buffer 41 42 43>, <Buffer 41 42 43 44>, <Buffer 42 43 44> ]
    // (This result is equal to: [buf1, buf3, buf2].)
-
    -

    The optional targetStart, targetEnd, sourceStart, and sourceEndarguments can be used to limit the comparison to specific ranges within targetand buf respectively.

    -
    import { Buffer } from 'buffer';

    const buf1 = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8, 9]);
    const buf2 = Buffer.from([5, 6, 7, 8, 9, 1, 2, 3, 4]);

    console.log(buf1.compare(buf2, 5, 9, 0, 4));
    // Prints: 0
    console.log(buf1.compare(buf2, 0, 6, 4));
    // Prints: -1
    console.log(buf1.compare(buf2, 5, 6, 5));
    // Prints: 1
-
    -

    ERR_OUT_OF_RANGE is thrown if targetStart < 0, sourceStart < 0,targetEnd > target.byteLength, or sourceEnd > source.byteLength.

    -
    since

    v0.11.13

    -

    Parameters

    • target: <internal>.Uint8Array
      -

      A Buffer or Uint8Array with which to compare buf.

      -
    • Optional targetStart: number
    • Optional targetEnd: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

copy

  • copy(target: <internal>.Uint8Array, targetStart?: number, sourceStart?: number, sourceEnd?: number): number
  • -

    Copies data from a region of buf to a region in target, even if the targetmemory region overlaps with buf.

    -

    TypedArray.prototype.set() performs the same operation, and is available -for all TypedArrays, including Node.js Buffers, although it takes -different function arguments.

    -
    import { Buffer } from 'buffer';

    // Create two `Buffer` instances.
    const buf1 = Buffer.allocUnsafe(26);
    const buf2 = Buffer.allocUnsafe(26).fill('!');

    for (let i = 0; i < 26; i++) {
      // 97 is the decimal ASCII value for 'a'.
      buf1[i] = i + 97;
    }

    // Copy `buf1` bytes 16 through 19 into `buf2` starting at byte 8 of `buf2`.
    buf1.copy(buf2, 8, 16, 20);
    // This is equivalent to:
    // buf2.set(buf1.subarray(16, 20), 8);

    console.log(buf2.toString('ascii', 0, 25));
    // Prints: !!!!!!!!qrst!!!!!!!!!!!!!
-
    -
    import { Buffer } from 'buffer';

    // Create a `Buffer` and copy data from one region to an overlapping region
    // within the same `Buffer`.

    const buf = Buffer.allocUnsafe(26);

    for (let i = 0; i < 26; i++) {
      // 97 is the decimal ASCII value for 'a'.
      buf[i] = i + 97;
    }

    buf.copy(buf, 0, 4, 10);

    console.log(buf.toString());
    // Prints: efghijghijklmnopqrstuvwxyz
-
    -
    since

    v0.1.90

    -

    Parameters

    • target: <internal>.Uint8Array
      -

      A Buffer or Uint8Array to copy into.

      -
    • Optional targetStart: number
    • Optional sourceStart: number
    • Optional sourceEnd: number

    Returns number

    The number of bytes copied.

    -

copyWithin

  • -

    Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

    -

    Parameters

    • target: number
      -

      If target is negative, it is treated as length+target where length is the -length of the array.

      -
    • start: number
      -

      If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

      -
    • Optional end: number
      -

      If not specified, length of the this object is used as its default value.

      -

    Returns <internal>.Buffer

entries

  • -

    Creates and returns an iterator of [index, byte] pairs from the contents -of buf.

    -
    import { Buffer } from 'buffer';

    // Log the entire contents of a `Buffer`.

    const buf = Buffer.from('buffer');

    for (const pair of buf.entries()) {
      console.log(pair);
    }
    // Prints:
    //   [0, 98]
    //   [1, 117]
    //   [2, 102]
    //   [3, 102]
    //   [4, 101]
    //   [5, 114]
-
    -
    since

    v1.1.0

    -

    Returns IterableIterator<[number, number]>

equals

  • -

    Returns true if both buf and otherBuffer have exactly the same bytes,false otherwise. Equivalent to buf.compare(otherBuffer) === 0.

    -
    import { Buffer } from 'buffer';

    const buf1 = Buffer.from('ABC');
    const buf2 = Buffer.from('414243', 'hex');
    const buf3 = Buffer.from('ABCD');

    console.log(buf1.equals(buf2));
    // Prints: true
    console.log(buf1.equals(buf3));
    // Prints: false
-
    -
    since

    v0.11.13

    -

    Parameters

    Returns boolean

every

  • every(predicate: (value: number, index: number, array: <internal>.Uint8Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether all the members of an array satisfy the specified test.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Uint8Array) => unknown
      -

      A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

fill

  • -

    Fills buf with the specified value. If the offset and end are not given, -the entire buf will be filled:

    -
    import { Buffer } from 'buffer';

    // Fill a `Buffer` with the ASCII character 'h'.

    const b = Buffer.allocUnsafe(50).fill('h');

    console.log(b.toString());
    // Prints: hhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhhh
-
    -

    value is coerced to a uint32 value if it is not a string, Buffer, or -integer. If the resulting integer is greater than 255 (decimal), buf will be -filled with value &#x26; 255.

    -

    If the final write of a fill() operation falls on a multi-byte character, -then only the bytes of that character that fit into buf are written:

    -
    import { Buffer } from 'buffer';

    // Fill a `Buffer` with character that takes up two bytes in UTF-8.

    console.log(Buffer.allocUnsafe(5).fill('\u0222'));
    // Prints: <Buffer c8 a2 c8 a2 c8>
-
    -

    If value contains invalid characters, it is truncated; if no valid -fill data remains, an exception is thrown:

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(5);

    console.log(buf.fill('a'));
    // Prints: <Buffer 61 61 61 61 61>
    console.log(buf.fill('aazz', 'hex'));
    // Prints: <Buffer aa aa aa aa aa>
    console.log(buf.fill('zz', 'hex'));
    // Throws an exception.
-
    -
    since

    v0.5.0

    -

    Parameters

    Returns <internal>.Buffer

    A reference to buf.

    -

filter

  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Uint8Array) => any
      -

      A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Uint8Array

find

  • find(predicate: (value: number, index: number, obj: <internal>.Uint8Array) => boolean, thisArg?: any): undefined | number
  • -

    Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Uint8Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns undefined | number

findIndex

  • findIndex(predicate: (value: number, index: number, obj: <internal>.Uint8Array) => boolean, thisArg?: any): number
  • -

    Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Uint8Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns number

forEach

  • forEach(callbackfn: (value: number, index: number, array: <internal>.Uint8Array) => void, thisArg?: any): void
  • -

    Performs the specified action for each element in an array.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Uint8Array) => void
      -

      A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns void

includes

  • -

    Equivalent to buf.indexOf() !== -1.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from('this is a buffer');

    console.log(buf.includes('this'));
    // Prints: true
    console.log(buf.includes('is'));
    // Prints: true
    console.log(buf.includes(Buffer.from('a buffer')));
    // Prints: true
    console.log(buf.includes(97));
    // Prints: true (97 is the decimal ASCII value for 'a')
    console.log(buf.includes(Buffer.from('a buffer example')));
    // Prints: false
    console.log(buf.includes(Buffer.from('a buffer example').slice(0, 8)));
    // Prints: true
    console.log(buf.includes('this', 4));
    // Prints: false
-
    -
    since

    v5.3.0

    -

    Parameters

    Returns boolean

    true if value was found in buf, false otherwise.

    -

indexOf

  • -

    If value is:

    -
      -
    • a string, value is interpreted according to the character encoding inencoding.
      • -
    • a Buffer or Uint8Array, value will be used in its entirety. -To compare a partial Buffer, use buf.slice().
      • -
    • a number, value will be interpreted as an unsigned 8-bit integer -value between 0 and 255.
      • -
    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from('this is a buffer');

    console.log(buf.indexOf('this'));
    // Prints: 0
    console.log(buf.indexOf('is'));
    // Prints: 2
    console.log(buf.indexOf(Buffer.from('a buffer')));
    // Prints: 8
    console.log(buf.indexOf(97));
    // Prints: 8 (97 is the decimal ASCII value for 'a')
    console.log(buf.indexOf(Buffer.from('a buffer example')));
    // Prints: -1
    console.log(buf.indexOf(Buffer.from('a buffer example').slice(0, 8)));
    // Prints: 8

    const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

    console.log(utf16Buffer.indexOf('\u03a3', 0, 'utf16le'));
    // Prints: 4
    console.log(utf16Buffer.indexOf('\u03a3', -4, 'utf16le'));
    // Prints: 6
-
    -

    If value is not a string, number, or Buffer, this method will throw aTypeError. If value is a number, it will be coerced to a valid byte value, -an integer between 0 and 255.

    -

    If byteOffset is not a number, it will be coerced to a number. If the result -of coercion is NaN or 0, then the entire buffer will be searched. This -behavior matches String.prototype.indexOf().

    -
    import { Buffer } from 'buffer';

    const b = Buffer.from('abcdef');

    // Passing a value that's a number, but not a valid byte.
    // Prints: 2, equivalent to searching for 99 or 'c'.
    console.log(b.indexOf(99.9));
    console.log(b.indexOf(256 + 99));

    // Passing a byteOffset that coerces to NaN or 0.
    // Prints: 1, searching the whole buffer.
    console.log(b.indexOf('b', undefined));
    console.log(b.indexOf('b', {}));
    console.log(b.indexOf('b', null));
    console.log(b.indexOf('b', []));
-
    -

    If value is an empty string or empty Buffer and byteOffset is less -than buf.length, byteOffset will be returned. If value is empty andbyteOffset is at least buf.length, buf.length will be returned.

    -
    since

    v1.5.0

    -

    Parameters

    Returns number

    The index of the first occurrence of value in buf, or -1 if buf does not contain value.

    -

join

  • join(separator?: string): string
  • -

    Adds all the elements of an array separated by the specified separator string.

    -

    Parameters

    • Optional separator: string
      -

      A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

      -

    Returns string

keys

  • -

    Creates and returns an iterator of buf keys (indices).

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from('buffer');

    for (const key of buf.keys()) {
      console.log(key);
    }
    // Prints:
    //   0
    //   1
    //   2
    //   3
    //   4
    //   5
-
    -
    since

    v1.1.0

    -

    Returns IterableIterator<number>

lastIndexOf

  • -

    Identical to buf.indexOf(), except the last occurrence of value is found -rather than the first occurrence.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from('this buffer is a buffer');

    console.log(buf.lastIndexOf('this'));
    // Prints: 0
    console.log(buf.lastIndexOf('buffer'));
    // Prints: 17
    console.log(buf.lastIndexOf(Buffer.from('buffer')));
    // Prints: 17
    console.log(buf.lastIndexOf(97));
    // Prints: 15 (97 is the decimal ASCII value for 'a')
    console.log(buf.lastIndexOf(Buffer.from('yolo')));
    // Prints: -1
    console.log(buf.lastIndexOf('buffer', 5));
    // Prints: 5
    console.log(buf.lastIndexOf('buffer', 4));
    // Prints: -1

    const utf16Buffer = Buffer.from('\u039a\u0391\u03a3\u03a3\u0395', 'utf16le');

    console.log(utf16Buffer.lastIndexOf('\u03a3', undefined, 'utf16le'));
    // Prints: 6
    console.log(utf16Buffer.lastIndexOf('\u03a3', -5, 'utf16le'));
    // Prints: 4
-
    -

    If value is not a string, number, or Buffer, this method will throw aTypeError. If value is a number, it will be coerced to a valid byte value, -an integer between 0 and 255.

    -

    If byteOffset is not a number, it will be coerced to a number. Any arguments -that coerce to NaN, like {} or undefined, will search the whole buffer. -This behavior matches String.prototype.lastIndexOf().

    -
    import { Buffer } from 'buffer';

    const b = Buffer.from('abcdef');

    // Passing a value that's a number, but not a valid byte.
    // Prints: 2, equivalent to searching for 99 or 'c'.
    console.log(b.lastIndexOf(99.9));
    console.log(b.lastIndexOf(256 + 99));

    // Passing a byteOffset that coerces to NaN.
    // Prints: 1, searching the whole buffer.
    console.log(b.lastIndexOf('b', undefined));
    console.log(b.lastIndexOf('b', {}));

    // Passing a byteOffset that coerces to 0.
    // Prints: -1, equivalent to passing 0.
    console.log(b.lastIndexOf('b', null));
    console.log(b.lastIndexOf('b', []));
-
    -

    If value is an empty string or empty Buffer, byteOffset will be returned.

    -
    since

    v6.0.0

    -

    Parameters

    Returns number

    The index of the last occurrence of value in buf, or -1 if buf does not contain value.

    -

map

  • -

    Calls a defined callback function on each element of an array, and returns an array that -contains the results.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Uint8Array) => number
      -

      A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Uint8Array

readBigInt64BE

  • readBigInt64BE(offset?: number): bigint
  • -

    Reads a signed, big-endian 64-bit integer from buf at the specified offset.

    -

    Integers read from a Buffer are interpreted as two's complement signed -values.

    -
    since

    v12.0.0, v10.20.0

    -

    Parameters

    • Optional offset: number

    Returns bigint

readBigInt64LE

  • readBigInt64LE(offset?: number): bigint
  • -

    Reads a signed, little-endian 64-bit integer from buf at the specifiedoffset.

    -

    Integers read from a Buffer are interpreted as two's complement signed -values.

    -
    since

    v12.0.0, v10.20.0

    -

    Parameters

    • Optional offset: number

    Returns bigint

readBigUInt64BE

  • readBigUInt64BE(offset?: number): bigint
  • -

    Reads an unsigned, big-endian 64-bit integer from buf at the specifiedoffset.

    -

    This function is also available under the readBigUint64BE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

    console.log(buf.readBigUInt64BE(0));
    // Prints: 4294967295n
-
    -
    since

    v12.0.0, v10.20.0

    -

    Parameters

    • Optional offset: number

    Returns bigint

readBigUInt64LE

  • readBigUInt64LE(offset?: number): bigint
  • -

    Reads an unsigned, little-endian 64-bit integer from buf at the specifiedoffset.

    -

    This function is also available under the readBigUint64LE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x00, 0x00, 0x00, 0x00, 0xff, 0xff, 0xff, 0xff]);

    console.log(buf.readBigUInt64LE(0));
    // Prints: 18446744069414584320n
-
    -
    since

    v12.0.0, v10.20.0

    -

    Parameters

    • Optional offset: number

    Returns bigint

readDoubleBE

  • readDoubleBE(offset?: number): number
  • -

    Reads a 64-bit, big-endian double from buf at the specified offset.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

    console.log(buf.readDoubleBE(0));
    // Prints: 8.20788039913184e-304
-
    -
    since

    v0.11.15

    -

    Parameters

    • Optional offset: number

    Returns number

readDoubleLE

  • readDoubleLE(offset?: number): number
  • -

    Reads a 64-bit, little-endian double from buf at the specified offset.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([1, 2, 3, 4, 5, 6, 7, 8]);

    console.log(buf.readDoubleLE(0));
    // Prints: 5.447603722011605e-270
    console.log(buf.readDoubleLE(1));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.11.15

    -

    Parameters

    • Optional offset: number

    Returns number

readFloatBE

  • readFloatBE(offset?: number): number
  • -

    Reads a 32-bit, big-endian float from buf at the specified offset.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([1, 2, 3, 4]);

    console.log(buf.readFloatBE(0));
    // Prints: 2.387939260590663e-38
-
    -
    since

    v0.11.15

    -

    Parameters

    • Optional offset: number

    Returns number

readFloatLE

  • readFloatLE(offset?: number): number
  • -

    Reads a 32-bit, little-endian float from buf at the specified offset.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([1, 2, 3, 4]);

    console.log(buf.readFloatLE(0));
    // Prints: 1.539989614439558e-36
    console.log(buf.readFloatLE(1));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.11.15

    -

    Parameters

    • Optional offset: number

    Returns number

readInt16BE

  • readInt16BE(offset?: number): number
  • -

    Reads a signed, big-endian 16-bit integer from buf at the specified offset.

    -

    Integers read from a Buffer are interpreted as two's complement signed values.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0, 5]);

    console.log(buf.readInt16BE(0));
    // Prints: 5
-
    -
    since

    v0.5.5

    -

    Parameters

    • Optional offset: number

    Returns number

readInt16LE

  • readInt16LE(offset?: number): number
  • -

    Reads a signed, little-endian 16-bit integer from buf at the specifiedoffset.

    -

    Integers read from a Buffer are interpreted as two's complement signed values.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0, 5]);

    console.log(buf.readInt16LE(0));
    // Prints: 1280
    console.log(buf.readInt16LE(1));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.5.5

    -

    Parameters

    • Optional offset: number

    Returns number

readInt32BE

  • readInt32BE(offset?: number): number
  • -

    Reads a signed, big-endian 32-bit integer from buf at the specified offset.

    -

    Integers read from a Buffer are interpreted as two's complement signed values.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0, 0, 0, 5]);

    console.log(buf.readInt32BE(0));
    // Prints: 5
-
    -
    since

    v0.5.5

    -

    Parameters

    • Optional offset: number

    Returns number

readInt32LE

  • readInt32LE(offset?: number): number
  • -

    Reads a signed, little-endian 32-bit integer from buf at the specifiedoffset.

    -

    Integers read from a Buffer are interpreted as two's complement signed values.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0, 0, 0, 5]);

    console.log(buf.readInt32LE(0));
    // Prints: 83886080
    console.log(buf.readInt32LE(1));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.5.5

    -

    Parameters

    • Optional offset: number

    Returns number

readInt8

  • readInt8(offset?: number): number
  • -

    Reads a signed 8-bit integer from buf at the specified offset.

    -

    Integers read from a Buffer are interpreted as two's complement signed values.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([-1, 5]);

    console.log(buf.readInt8(0));
    // Prints: -1
    console.log(buf.readInt8(1));
    // Prints: 5
    console.log(buf.readInt8(2));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.5.0

    -

    Parameters

    • Optional offset: number

    Returns number

readIntBE

  • readIntBE(offset: number, byteLength: number): number
  • -

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a big-endian, two's complement signed value -supporting up to 48 bits of accuracy.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readIntBE(0, 6).toString(16));
    // Prints: 1234567890ab
    console.log(buf.readIntBE(1, 6).toString(16));
    // Throws ERR_OUT_OF_RANGE.
    console.log(buf.readIntBE(1, 0).toString(16));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.11.15

    -

    Parameters

    • offset: number
      -

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      -
    • byteLength: number
      -

      Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      -

    Returns number

readIntLE

  • readIntLE(offset: number, byteLength: number): number
  • -

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as a little-endian, two's complement signed value -supporting up to 48 bits of accuracy.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readIntLE(0, 6).toString(16));
    // Prints: -546f87a9cbee
-
    -
    since

    v0.11.15

    -

    Parameters

    • offset: number
      -

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      -
    • byteLength: number
      -

      Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      -

    Returns number

readUInt16BE

  • readUInt16BE(offset?: number): number
  • -

    Reads an unsigned, big-endian 16-bit integer from buf at the specifiedoffset.

    -

    This function is also available under the readUint16BE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56]);

    console.log(buf.readUInt16BE(0).toString(16));
    // Prints: 1234
    console.log(buf.readUInt16BE(1).toString(16));
    // Prints: 3456
-
    -
    since

    v0.5.5

    -

    Parameters

    • Optional offset: number

    Returns number

readUInt16LE

  • readUInt16LE(offset?: number): number
  • -

    Reads an unsigned, little-endian 16-bit integer from buf at the specifiedoffset.

    -

    This function is also available under the readUint16LE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56]);

    console.log(buf.readUInt16LE(0).toString(16));
    // Prints: 3412
    console.log(buf.readUInt16LE(1).toString(16));
    // Prints: 5634
    console.log(buf.readUInt16LE(2).toString(16));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.5.5

    -

    Parameters

    • Optional offset: number

    Returns number

readUInt32BE

  • readUInt32BE(offset?: number): number
  • -

    Reads an unsigned, big-endian 32-bit integer from buf at the specifiedoffset.

    -

    This function is also available under the readUint32BE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

    console.log(buf.readUInt32BE(0).toString(16));
    // Prints: 12345678
-
    -
    since

    v0.5.5

    -

    Parameters

    • Optional offset: number

    Returns number

readUInt32LE

  • readUInt32LE(offset?: number): number
  • -

    Reads an unsigned, little-endian 32-bit integer from buf at the specifiedoffset.

    -

    This function is also available under the readUint32LE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78]);

    console.log(buf.readUInt32LE(0).toString(16));
    // Prints: 78563412
    console.log(buf.readUInt32LE(1).toString(16));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.5.5

    -

    Parameters

    • Optional offset: number

    Returns number

readUInt8

  • readUInt8(offset?: number): number
  • -

    Reads an unsigned 8-bit integer from buf at the specified offset.

    -

    This function is also available under the readUint8 alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([1, -2]);

    console.log(buf.readUInt8(0));
    // Prints: 1
    console.log(buf.readUInt8(1));
    // Prints: 254
    console.log(buf.readUInt8(2));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.5.0

    -

    Parameters

    • Optional offset: number

    Returns number

readUIntBE

  • readUIntBE(offset: number, byteLength: number): number
  • -

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned big-endian integer supporting -up to 48 bits of accuracy.

    -

    This function is also available under the readUintBE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readUIntBE(0, 6).toString(16));
    // Prints: 1234567890ab
    console.log(buf.readUIntBE(1, 6).toString(16));
    // Throws ERR_OUT_OF_RANGE.
-
    -
    since

    v0.11.15

    -

    Parameters

    • offset: number
      -

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      -
    • byteLength: number
      -

      Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      -

    Returns number

readUIntLE

  • readUIntLE(offset: number, byteLength: number): number
  • -

    Reads byteLength number of bytes from buf at the specified offsetand interprets the result as an unsigned, little-endian integer supporting -up to 48 bits of accuracy.

    -

    This function is also available under the readUintLE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x12, 0x34, 0x56, 0x78, 0x90, 0xab]);

    console.log(buf.readUIntLE(0, 6).toString(16));
    // Prints: ab9078563412
-
    -
    since

    v0.11.15

    -

    Parameters

    • offset: number
      -

      Number of bytes to skip before starting to read. Must satisfy 0 <= offset <= buf.length - byteLength.

      -
    • byteLength: number
      -

      Number of bytes to read. Must satisfy 0 < byteLength <= 6.

      -

    Returns number

reduce

  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number): number
  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number, initialValue: number): number
  • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array): number

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array): number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => U
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number): number
  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number, initialValue: number): number
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array): number

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array): number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => U
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reverse

  • Returns <internal>.Buffer

set

  • set(array: ArrayLike<number>, offset?: number): void
  • -

    Sets a value or an array of values.

    -

    Parameters

    • array: ArrayLike<number>
      -

      A typed or untyped array of values to set.

      -
    • Optional offset: number
      -

      The index in the current array at which the values are to be written.

      -

    Returns void

slice

  • -

    Returns a new Buffer that references the same memory as the original, but -offset and cropped by the start and end indices.

    -

    This is the same behavior as buf.subarray().

    -

    This method is not compatible with the Uint8Array.prototype.slice(), -which is a superclass of Buffer. To copy the slice, useUint8Array.prototype.slice().

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from('buffer');

    const copiedBuf = Uint8Array.prototype.slice.call(buf);
    copiedBuf[0]++;
    console.log(copiedBuf.toString());
    // Prints: cuffer

    console.log(buf.toString());
    // Prints: buffer
-
    -
    since

    v0.3.0

    -

    Parameters

    • Optional start: number
    • Optional end: number

    Returns <internal>.Buffer

some

  • some(predicate: (value: number, index: number, array: <internal>.Uint8Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether the specified callback function returns true for any element of an array.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Uint8Array) => unknown
      -

      A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

sort

  • -

    Sorts an array.

    -

    Parameters

    • Optional compareFn: (a: number, b: number) => number
      -

      Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      -
      [11,2,22,1].sort((a, b) => a - b)
-
      -
        • (a: number, b: number): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns <internal>.Buffer

subarray

  • -

    Returns a new Buffer that references the same memory as the original, but -offset and cropped by the start and end indices.

    -

    Specifying end greater than buf.length will return the same result as -that of end equal to buf.length.

    -

    This method is inherited from TypedArray.prototype.subarray().

    -

    Modifying the new Buffer slice will modify the memory in the original Bufferbecause the allocated memory of the two objects overlap.

    -
    import { Buffer } from 'buffer';

    // Create a `Buffer` with the ASCII alphabet, take a slice, and modify one byte
    // from the original `Buffer`.

    const buf1 = Buffer.allocUnsafe(26);

    for (let i = 0; i < 26; i++) {
      // 97 is the decimal ASCII value for 'a'.
      buf1[i] = i + 97;
    }

    const buf2 = buf1.subarray(0, 3);

    console.log(buf2.toString('ascii', 0, buf2.length));
    // Prints: abc

    buf1[0] = 33;

    console.log(buf2.toString('ascii', 0, buf2.length));
    // Prints: !bc
-
    -

    Specifying negative indexes causes the slice to be generated relative to the -end of buf rather than the beginning.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from('buffer');

    console.log(buf.subarray(-6, -1).toString());
    // Prints: buffe
    // (Equivalent to buf.subarray(0, 5).)

    console.log(buf.subarray(-6, -2).toString());
    // Prints: buff
    // (Equivalent to buf.subarray(0, 4).)

    console.log(buf.subarray(-5, -2).toString());
    // Prints: uff
    // (Equivalent to buf.subarray(1, 4).)
-
    -
    since

    v3.0.0

    -

    Parameters

    • Optional start: number
    • Optional end: number

    Returns <internal>.Buffer

swap16

  • -

    Interprets buf as an array of unsigned 16-bit integers and swaps the -byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 2.

    -
    import { Buffer } from 'buffer';

    const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

    console.log(buf1);
    // Prints: <Buffer 01 02 03 04 05 06 07 08>

    buf1.swap16();

    console.log(buf1);
    // Prints: <Buffer 02 01 04 03 06 05 08 07>

    const buf2 = Buffer.from([0x1, 0x2, 0x3]);

    buf2.swap16();
    // Throws ERR_INVALID_BUFFER_SIZE.
-
    -

    One convenient use of buf.swap16() is to perform a fast in-place conversion -between UTF-16 little-endian and UTF-16 big-endian:

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from('This is little-endian UTF-16', 'utf16le');
    buf.swap16(); // Convert to big-endian UTF-16 text.
-
    -
    since

    v5.10.0

    -

    Returns <internal>.Buffer

    A reference to buf.

    -

swap32

  • -

    Interprets buf as an array of unsigned 32-bit integers and swaps the -byte order in-place. Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 4.

    -
    import { Buffer } from 'buffer';

    const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

    console.log(buf1);
    // Prints: <Buffer 01 02 03 04 05 06 07 08>

    buf1.swap32();

    console.log(buf1);
    // Prints: <Buffer 04 03 02 01 08 07 06 05>

    const buf2 = Buffer.from([0x1, 0x2, 0x3]);

    buf2.swap32();
    // Throws ERR_INVALID_BUFFER_SIZE.
-
    -
    since

    v5.10.0

    -

    Returns <internal>.Buffer

    A reference to buf.

    -

swap64

  • -

    Interprets buf as an array of 64-bit numbers and swaps byte order in-place. -Throws ERR_INVALID_BUFFER_SIZE if buf.length is not a multiple of 8.

    -
    import { Buffer } from 'buffer';

    const buf1 = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5, 0x6, 0x7, 0x8]);

    console.log(buf1);
    // Prints: <Buffer 01 02 03 04 05 06 07 08>

    buf1.swap64();

    console.log(buf1);
    // Prints: <Buffer 08 07 06 05 04 03 02 01>

    const buf2 = Buffer.from([0x1, 0x2, 0x3]);

    buf2.swap64();
    // Throws ERR_INVALID_BUFFER_SIZE.
-
    -
    since

    v6.3.0

    -

    Returns <internal>.Buffer

    A reference to buf.

    -

toJSON

  • toJSON(): { data: number[]; type: "Buffer" }
  • -

    Returns a JSON representation of buf. JSON.stringify() implicitly calls -this function when stringifying a Buffer instance.

    -

    Buffer.from() accepts objects in the format returned from this method. -In particular, Buffer.from(buf.toJSON()) works like Buffer.from(buf).

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from([0x1, 0x2, 0x3, 0x4, 0x5]);
    const json = JSON.stringify(buf);

    console.log(json);
    // Prints: {"type":"Buffer","data":[1,2,3,4,5]}

    const copy = JSON.parse(json, (key, value) => {
      return value &#x26;&#x26; value.type === 'Buffer' ?
        Buffer.from(value) :
        value;
    });

    console.log(copy);
    // Prints: <Buffer 01 02 03 04 05>
-
    -
    since

    v0.9.2

    -

    Returns { data: number[]; type: "Buffer" }

    • data: number[]
    • type: "Buffer"

toLocaleString

  • toLocaleString(): string
  • -

    Converts a number to a string by using the current locale.

    -

    Returns string

toString

  • toString(encoding?: BufferEncoding, start?: number, end?: number): string
  • -

    Decodes buf to a string according to the specified character encoding inencoding. start and end may be passed to decode only a subset of buf.

    -

    If encoding is 'utf8' and a byte sequence in the input is not valid UTF-8, -then each invalid byte is replaced with the replacement character U+FFFD.

    -

    The maximum length of a string instance (in UTF-16 code units) is available -as {@link constants.MAX_STRING_LENGTH}.

    -
    import { Buffer } from 'buffer';

    const buf1 = Buffer.allocUnsafe(26);

    for (let i = 0; i < 26; i++) {
      // 97 is the decimal ASCII value for 'a'.
      buf1[i] = i + 97;
    }

    console.log(buf1.toString('utf8'));
    // Prints: abcdefghijklmnopqrstuvwxyz
    console.log(buf1.toString('utf8', 0, 5));
    // Prints: abcde

    const buf2 = Buffer.from('tést');

    console.log(buf2.toString('hex'));
    // Prints: 74c3a97374
    console.log(buf2.toString('utf8', 0, 3));
    // Prints: té
    console.log(buf2.toString(undefined, 0, 3));
    // Prints: té
-
    -
    since

    v0.1.90

    -

    Parameters

    • Optional encoding: BufferEncoding
    • Optional start: number
    • Optional end: number

    Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.Uint8Array

values

  • -

    Creates and returns an iterator for buf values (bytes). This function is -called automatically when a Buffer is used in a for..of statement.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.from('buffer');

    for (const value of buf.values()) {
      console.log(value);
    }
    // Prints:
    //   98
    //   117
    //   102
    //   102
    //   101
    //   114

    for (const value of buf) {
      console.log(value);
    }
    // Prints:
    //   98
    //   117
    //   102
    //   102
    //   101
    //   114
-
    -
    since

    v1.1.0

    -

    Returns IterableIterator<number>

write

  • write(string: string, encoding?: BufferEncoding): number
  • write(string: string, offset: number, encoding?: BufferEncoding): number
  • write(string: string, offset: number, length: number, encoding?: BufferEncoding): number
  • -

    Writes string to buf at offset according to the character encoding inencoding. The length parameter is the number of bytes to write. If buf did -not contain enough space to fit the entire string, only part of string will be -written. However, partially encoded characters will not be written.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.alloc(256);

    const len = buf.write('\u00bd + \u00bc = \u00be', 0);

    console.log(`${len} bytes: ${buf.toString('utf8', 0, len)}`);
    // Prints: 12 bytes: ½ + ¼ = ¾

    const buffer = Buffer.alloc(10);

    const length = buffer.write('abcd', 8);

    console.log(`${length} bytes: ${buffer.toString('utf8', 8, 10)}`);
    // Prints: 2 bytes : ab
-
    -
    since

    v0.1.90

    -

    Parameters

    • string: string
      -

      String to write to buf.

      -
    • Optional encoding: BufferEncoding

    Returns number

    Number of bytes written.

    -

  • Parameters

    Returns number

  • Parameters

    • string: string
    • offset: number
    • length: number
    • Optional encoding: BufferEncoding

    Returns number

writeBigInt64BE

  • writeBigInt64BE(value: bigint, offset?: number): number
  • -

    Writes value to buf at the specified offset as big-endian.

    -

    value is interpreted and written as a two's complement signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeBigInt64BE(0x0102030405060708n, 0);

    console.log(buf);
    // Prints: <Buffer 01 02 03 04 05 06 07 08>
-
    -
    since

    v12.0.0, v10.20.0

    -

    Parameters

    • value: bigint
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeBigInt64LE

  • writeBigInt64LE(value: bigint, offset?: number): number
  • -

    Writes value to buf at the specified offset as little-endian.

    -

    value is interpreted and written as a two's complement signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeBigInt64LE(0x0102030405060708n, 0);

    console.log(buf);
    // Prints: <Buffer 08 07 06 05 04 03 02 01>
-
    -
    since

    v12.0.0, v10.20.0

    -

    Parameters

    • value: bigint
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeBigUInt64BE

  • writeBigUInt64BE(value: bigint, offset?: number): number
  • -

    Writes value to buf at the specified offset as big-endian.

    -

    This function is also available under the writeBigUint64BE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeBigUInt64BE(0xdecafafecacefaden, 0);

    console.log(buf);
    // Prints: <Buffer de ca fa fe ca ce fa de>
-
    -
    since

    v12.0.0, v10.20.0

    -

    Parameters

    • value: bigint
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeBigUInt64LE

  • writeBigUInt64LE(value: bigint, offset?: number): number
  • -

    Writes value to buf at the specified offset as little-endian

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeBigUInt64LE(0xdecafafecacefaden, 0);

    console.log(buf);
    // Prints: <Buffer de fa ce ca fe fa ca de>
-
    -

    This function is also available under the writeBigUint64LE alias.

    -
    since

    v12.0.0, v10.20.0

    -

    Parameters

    • value: bigint
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeDoubleBE

  • writeDoubleBE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as big-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything -other than a JavaScript number.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeDoubleBE(123.456, 0);

    console.log(buf);
    // Prints: <Buffer 40 5e dd 2f 1a 9f be 77>
-
    -
    since

    v0.11.15

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeDoubleLE

  • writeDoubleLE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as little-endian. The valuemust be a JavaScript number. Behavior is undefined when value is anything -other than a JavaScript number.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(8);

    buf.writeDoubleLE(123.456, 0);

    console.log(buf);
    // Prints: <Buffer 77 be 9f 1a 2f dd 5e 40>
-
    -
    since

    v0.11.15

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeFloatBE

  • writeFloatBE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as big-endian. Behavior is -undefined when value is anything other than a JavaScript number.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeFloatBE(0xcafebabe, 0);

    console.log(buf);
    // Prints: <Buffer 4f 4a fe bb>
-
    -
    since

    v0.11.15

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeFloatLE

  • writeFloatLE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as little-endian. Behavior is -undefined when value is anything other than a JavaScript number.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeFloatLE(0xcafebabe, 0);

    console.log(buf);
    // Prints: <Buffer bb fe 4a 4f>
-
    -
    since

    v0.11.15

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeInt16BE

  • writeInt16BE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is -anything other than a signed 16-bit integer.

    -

    The value is interpreted and written as a two's complement signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(2);

    buf.writeInt16BE(0x0102, 0);

    console.log(buf);
    // Prints: <Buffer 01 02>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeInt16LE

  • writeInt16LE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 16-bit integer. Behavior is undefined when value is -anything other than a signed 16-bit integer.

    -

    The value is interpreted and written as a two's complement signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(2);

    buf.writeInt16LE(0x0304, 0);

    console.log(buf);
    // Prints: <Buffer 04 03>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeInt32BE

  • writeInt32BE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as big-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is -anything other than a signed 32-bit integer.

    -

    The value is interpreted and written as a two's complement signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeInt32BE(0x01020304, 0);

    console.log(buf);
    // Prints: <Buffer 01 02 03 04>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeInt32LE

  • writeInt32LE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as little-endian. The valuemust be a valid signed 32-bit integer. Behavior is undefined when value is -anything other than a signed 32-bit integer.

    -

    The value is interpreted and written as a two's complement signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeInt32LE(0x05060708, 0);

    console.log(buf);
    // Prints: <Buffer 08 07 06 05>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeInt8

  • writeInt8(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset. value must be a valid -signed 8-bit integer. Behavior is undefined when value is anything other than -a signed 8-bit integer.

    -

    value is interpreted and written as a two's complement signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(2);

    buf.writeInt8(2, 0);
    buf.writeInt8(-2, 1);

    console.log(buf);
    // Prints: <Buffer 02 fe>
-
    -
    since

    v0.5.0

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeIntBE

  • writeIntBE(value: number, offset: number, byteLength: number): number
  • -

    Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined whenvalue is anything other than a -signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(6);

    buf.writeIntBE(0x1234567890ab, 0, 6);

    console.log(buf);
    // Prints: <Buffer 12 34 56 78 90 ab>
-
    -
    since

    v0.11.15

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • offset: number
      -

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength.

      -
    • byteLength: number
      -

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

      -

    Returns number

    offset plus the number of bytes written.

    -

writeIntLE

  • writeIntLE(value: number, offset: number, byteLength: number): number
  • -

    Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined -when value is anything other than a signed integer.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(6);

    buf.writeIntLE(0x1234567890ab, 0, 6);

    console.log(buf);
    // Prints: <Buffer ab 90 78 56 34 12>
-
    -
    since

    v0.11.15

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • offset: number
      -

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength.

      -
    • byteLength: number
      -

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

      -

    Returns number

    offset plus the number of bytes written.

    -

writeUInt16BE

  • writeUInt16BE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when valueis anything other than an -unsigned 16-bit integer.

    -

    This function is also available under the writeUint16BE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt16BE(0xdead, 0);
    buf.writeUInt16BE(0xbeef, 2);

    console.log(buf);
    // Prints: <Buffer de ad be ef>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeUInt16LE

  • writeUInt16LE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 16-bit integer. Behavior is undefined when value is -anything other than an unsigned 16-bit integer.

    -

    This function is also available under the writeUint16LE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt16LE(0xdead, 0);
    buf.writeUInt16LE(0xbeef, 2);

    console.log(buf);
    // Prints: <Buffer ad de ef be>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeUInt32BE

  • writeUInt32BE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as big-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when valueis anything other than an -unsigned 32-bit integer.

    -

    This function is also available under the writeUint32BE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt32BE(0xfeedface, 0);

    console.log(buf);
    // Prints: <Buffer fe ed fa ce>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeUInt32LE

  • writeUInt32LE(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset as little-endian. The valuemust be a valid unsigned 32-bit integer. Behavior is undefined when value is -anything other than an unsigned 32-bit integer.

    -

    This function is also available under the writeUint32LE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt32LE(0xfeedface, 0);

    console.log(buf);
    // Prints: <Buffer ce fa ed fe>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeUInt8

  • writeUInt8(value: number, offset?: number): number
  • -

    Writes value to buf at the specified offset. value must be a -valid unsigned 8-bit integer. Behavior is undefined when value is anything -other than an unsigned 8-bit integer.

    -

    This function is also available under the writeUint8 alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(4);

    buf.writeUInt8(0x3, 0);
    buf.writeUInt8(0x4, 1);
    buf.writeUInt8(0x23, 2);
    buf.writeUInt8(0x42, 3);

    console.log(buf);
    // Prints: <Buffer 03 04 23 42>
-
    -
    since

    v0.5.0

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • Optional offset: number

    Returns number

    offset plus the number of bytes written.

    -

writeUIntBE

  • writeUIntBE(value: number, offset: number, byteLength: number): number
  • -

    Writes byteLength bytes of value to buf at the specified offsetas big-endian. Supports up to 48 bits of accuracy. Behavior is undefined -when value is anything other than an unsigned integer.

    -

    This function is also available under the writeUintBE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(6);

    buf.writeUIntBE(0x1234567890ab, 0, 6);

    console.log(buf);
    // Prints: <Buffer 12 34 56 78 90 ab>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • offset: number
      -

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength.

      -
    • byteLength: number
      -

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

      -

    Returns number

    offset plus the number of bytes written.

    -

writeUIntLE

  • writeUIntLE(value: number, offset: number, byteLength: number): number
  • -

    Writes byteLength bytes of value to buf at the specified offsetas little-endian. Supports up to 48 bits of accuracy. Behavior is undefined -when value is anything other than an unsigned integer.

    -

    This function is also available under the writeUintLE alias.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(6);

    buf.writeUIntLE(0x1234567890ab, 0, 6);

    console.log(buf);
    // Prints: <Buffer ab 90 78 56 34 12>
-
    -
    since

    v0.5.5

    -

    Parameters

    • value: number
      -

      Number to be written to buf.

      -
    • offset: number
      -

      Number of bytes to skip before starting to write. Must satisfy 0 <= offset <= buf.length - byteLength.

      -
    • byteLength: number
      -

      Number of bytes to write. Must satisfy 0 < byteLength <= 6.

      -

    Returns number

    offset plus the number of bytes written.

    -

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.BufferConstructor.html b/docs/interfaces/_internal_.BufferConstructor.html deleted file mode 100644 index 5028f76..0000000 --- a/docs/interfaces/_internal_.BufferConstructor.html +++ /dev/null @@ -1,175 +0,0 @@ -BufferConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface BufferConstructor

-

Raw data is stored in instances of the Buffer class. -A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. -Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'base64url'|'binary'(deprecated)|'hex'

-

Hierarchy

  • BufferConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

  • -

    Allocates a new buffer containing the given {str}.

    -
    deprecated

    since v10.0.0 - Use Buffer.from(string[, encoding]) instead.

    -

    Parameters

    • str: string
      -

      String to store in buffer.

      -
    • Optional encoding: BufferEncoding
      -

      encoding to use, optional. Default is 'utf8'

      -

    Returns <internal>.Buffer

  • -

    Allocates a new buffer of {size} octets.

    -
    deprecated

    since v10.0.0 - Use Buffer.alloc() instead (also see Buffer.allocUnsafe()).

    -

    Parameters

    • size: number
      -

      count of octets to allocate.

      -

    Returns <internal>.Buffer

  • -

    Allocates a new buffer containing the given {array} of octets.

    -
    deprecated

    since v10.0.0 - Use Buffer.from(array) instead.

    -

    Parameters

    Returns <internal>.Buffer

  • -

    Produces a Buffer backed by the same allocated memory as -the given {ArrayBuffer}/{SharedArrayBuffer}.

    -
    deprecated

    since v10.0.0 - Use Buffer.from(arrayBuffer[, byteOffset[, length]]) instead.

    -

    Parameters

    Returns <internal>.Buffer

  • -

    Allocates a new buffer containing the given {array} of octets.

    -
    deprecated

    since v10.0.0 - Use Buffer.from(array) instead.

    -

    Parameters

    • array: readonly any[]
      -

      The octets to store.

      -

    Returns <internal>.Buffer

  • -

    Copies the passed {buffer} data onto a new {Buffer} instance.

    -
    deprecated

    since v10.0.0 - Use Buffer.from(buffer) instead.

    -

    Parameters

    Returns <internal>.Buffer

Properties

poolSize

poolSize: number
-

This is the size (in bytes) of pre-allocated internal Buffer instances used -for pooling. This value may be modified.

-
since

v0.11.3

-

Methods

alloc

  • -

    Allocates a new Buffer of size bytes. If fill is undefined, theBuffer will be zero-filled.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.alloc(5);

    console.log(buf);
    // Prints: <Buffer 00 00 00 00 00>
-
    -

    If size is larger than {@link constants.MAX_LENGTH} or smaller than 0, ERR_INVALID_ARG_VALUE is thrown.

    -

    If fill is specified, the allocated Buffer will be initialized by calling buf.fill(fill).

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.alloc(5, 'a');

    console.log(buf);
    // Prints: <Buffer 61 61 61 61 61>
-
    -

    If both fill and encoding are specified, the allocated Buffer will be -initialized by calling buf.fill(fill, encoding).

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.alloc(11, 'aGVsbG8gd29ybGQ=', 'base64');

    console.log(buf);
    // Prints: <Buffer 68 65 6c 6c 6f 20 77 6f 72 6c 64>
-
    -

    Calling Buffer.alloc() can be measurably slower than the alternative Buffer.allocUnsafe() but ensures that the newly created Buffer instance -contents will never contain sensitive data from previous allocations, including -data that might not have been allocated for Buffers.

    -

    A TypeError will be thrown if size is not a number.

    -
    since

    v5.10.0

    -

    Parameters

    Returns <internal>.Buffer

allocUnsafe

  • -

    Allocates a new Buffer of size bytes. If size is larger than {@link constants.MAX_LENGTH} or smaller than 0, ERR_INVALID_ARG_VALUE is thrown.

    -

    The underlying memory for Buffer instances created in this way is not -initialized. The contents of the newly created Buffer are unknown and_may contain sensitive data_. Use Buffer.alloc() instead to initializeBuffer instances with zeroes.

    -
    import { Buffer } from 'buffer';

    const buf = Buffer.allocUnsafe(10);

    console.log(buf);
    // Prints (contents may vary): <Buffer a0 8b 28 3f 01 00 00 00 50 32>

    buf.fill(0);

    console.log(buf);
    // Prints: <Buffer 00 00 00 00 00 00 00 00 00 00>
-
    -

    A TypeError will be thrown if size is not a number.

    -

    The Buffer module pre-allocates an internal Buffer instance of -size Buffer.poolSize that is used as a pool for the fast allocation of newBuffer instances created using Buffer.allocUnsafe(),Buffer.from(array), Buffer.concat(), and the -deprecatednew Buffer(size) constructor only when size is less than or equal -to Buffer.poolSize >> 1 (floor of Buffer.poolSize divided by two).

    -

    Use of this pre-allocated internal memory pool is a key difference between -calling Buffer.alloc(size, fill) vs. Buffer.allocUnsafe(size).fill(fill). -Specifically, Buffer.alloc(size, fill) will never use the internal Bufferpool, while Buffer.allocUnsafe(size).fill(fill)will use the internalBuffer pool if size is less -than or equal to half Buffer.poolSize. The -difference is subtle but can be important when an application requires the -additional performance that Buffer.allocUnsafe() provides.

    -
    since

    v5.10.0

    -

    Parameters

    • size: number
      -

      The desired length of the new Buffer.

      -

    Returns <internal>.Buffer

allocUnsafeSlow

  • -

    Allocates a new Buffer of size bytes. If size is larger than {@link constants.MAX_LENGTH} or smaller than 0, ERR_INVALID_ARG_VALUE is thrown. A zero-length Buffer is created -if size is 0.

    -

    The underlying memory for Buffer instances created in this way is not -initialized. The contents of the newly created Buffer are unknown and_may contain sensitive data_. Use buf.fill(0) to initialize -such Buffer instances with zeroes.

    -

    When using Buffer.allocUnsafe() to allocate new Buffer instances, -allocations under 4 KB are sliced from a single pre-allocated Buffer. This -allows applications to avoid the garbage collection overhead of creating many -individually allocated Buffer instances. This approach improves both -performance and memory usage by eliminating the need to track and clean up as -many individual ArrayBuffer objects.

    -

    However, in the case where a developer may need to retain a small chunk of -memory from a pool for an indeterminate amount of time, it may be appropriate -to create an un-pooled Buffer instance using Buffer.allocUnsafeSlow() and -then copying out the relevant bits.

    -
    import { Buffer } from 'buffer';

    // Need to keep around a few small chunks of memory.
    const store = [];

    socket.on('readable', () => {
      let data;
      while (null !== (data = readable.read())) {
        // Allocate for retained data.
        const sb = Buffer.allocUnsafeSlow(10);

        // Copy the data into the new allocation.
        data.copy(sb, 0, 0, 10);

        store.push(sb);
      }
    });
-
    -

    A TypeError will be thrown if size is not a number.

    -
    since

    v5.12.0

    -

    Parameters

    • size: number
      -

      The desired length of the new Buffer.

      -

    Returns <internal>.Buffer

byteLength

  • -

    Returns the byte length of a string when encoded using encoding. -This is not the same as String.prototype.length, which does not account -for the encoding that is used to convert the string into bytes.

    -

    For 'base64', 'base64url', and 'hex', this function assumes valid input. -For strings that contain non-base64/hex-encoded data (e.g. whitespace), the -return value might be greater than the length of a Buffer created from the -string.

    -
    import { Buffer } from 'buffer';

    const str = '\u00bd + \u00bc = \u00be';

    console.log(`${str}: ${str.length} characters, ` +
                `${Buffer.byteLength(str, 'utf8')} bytes`);
    // Prints: ½ + ¼ = ¾: 9 characters, 12 bytes
-
    -

    When string is a -Buffer/DataView/[TypedArray](https://developer.mozilla.org/en-US/docs/Web/JavaScript/- -Reference/Global_Objects/TypedArray)/ArrayBuffer/[SharedArrayBuffer](https://develop- -er.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/SharedArrayBuffer), the byte length as reported by .byteLengthis returned.

    -
    since

    v0.1.90

    -

    Parameters

    Returns number

    The number of bytes contained within string.

    -

compare

  • -

    Compares buf1 to buf2, typically for the purpose of sorting arrays ofBuffer instances. This is equivalent to calling buf1.compare(buf2).

    -
    import { Buffer } from 'buffer';

    const buf1 = Buffer.from('1234');
    const buf2 = Buffer.from('0123');
    const arr = [buf1, buf2];

    console.log(arr.sort(Buffer.compare));
    // Prints: [ <Buffer 30 31 32 33>, <Buffer 31 32 33 34> ]
    // (This result is equal to: [buf2, buf1].)
-
    -
    since

    v0.11.13

    -

    Parameters

    Returns number

    Either -1, 0, or 1, depending on the result of the comparison. See compare for details.

    -

concat

  • -

    Returns a new Buffer which is the result of concatenating all the Bufferinstances in the list together.

    -

    If the list has no items, or if the totalLength is 0, then a new zero-lengthBuffer is returned.

    -

    If totalLength is not provided, it is calculated from the Buffer instances -in list by adding their lengths.

    -

    If totalLength is provided, it is coerced to an unsigned integer. If the -combined length of the Buffers in list exceeds totalLength, the result is -truncated to totalLength.

    -
    import { Buffer } from 'buffer';

    // Create a single `Buffer` from a list of three `Buffer` instances.

    const buf1 = Buffer.alloc(10);
    const buf2 = Buffer.alloc(14);
    const buf3 = Buffer.alloc(18);
    const totalLength = buf1.length + buf2.length + buf3.length;

    console.log(totalLength);
    // Prints: 42

    const bufA = Buffer.concat([buf1, buf2, buf3], totalLength);

    console.log(bufA);
    // Prints: <Buffer 00 00 00 00 ...>
    console.log(bufA.length);
    // Prints: 42
-
    -

    Buffer.concat() may also use the internal Buffer pool like Buffer.allocUnsafe() does.

    -
    since

    v0.7.11

    -

    Parameters

    • list: readonly <internal>.Uint8Array[]
      -

      List of Buffer or Uint8Array instances to concatenate.

      -
    • Optional totalLength: number
      -

      Total length of the Buffer instances in list when concatenated.

      -

    Returns <internal>.Buffer

from

  • -

    Allocates a new Buffer using an array of bytes in the range 0 – 255. -Array entries outside that range will be truncated to fit into it.

    -
    import { Buffer } from 'buffer';

    // Creates a new Buffer containing the UTF-8 bytes of the string 'buffer'.
    const buf = Buffer.from([0x62, 0x75, 0x66, 0x66, 0x65, 0x72]);
-
    -

    A TypeError will be thrown if array is not an Array or another type -appropriate for Buffer.from() variants.

    -

    Buffer.from(array) and Buffer.from(string) may also use the internalBuffer pool like Buffer.allocUnsafe() does.

    -
    since

    v5.10.0

    -

    Parameters

    Returns <internal>.Buffer

  • -

    Creates a new Buffer using the passed {data}

    -

    Parameters

    Returns <internal>.Buffer

  • Parameters

    Returns <internal>.Buffer

  • -

    Creates a new Buffer containing the given JavaScript string {str}. -If provided, the {encoding} parameter identifies the character encoding. -If not provided, {encoding} defaults to 'utf8'.

    -

    Parameters

    Returns <internal>.Buffer

isBuffer

  • -

    Returns true if obj is a Buffer, false otherwise.

    -
    import { Buffer } from 'buffer';

    Buffer.isBuffer(Buffer.alloc(10)); // true
    Buffer.isBuffer(Buffer.from('foo')); // true
    Buffer.isBuffer('a string'); // false
    Buffer.isBuffer([]); // false
    Buffer.isBuffer(new Uint8Array(1024)); // false
-
    -
    since

    v0.1.101

    -

    Parameters

    • obj: any

    Returns obj is <internal>.Buffer

isEncoding

  • -

    Returns true if encoding is the name of a supported character encoding, -or false otherwise.

    -
    import { Buffer } from 'buffer';

    console.log(Buffer.isEncoding('utf8'));
    // Prints: true

    console.log(Buffer.isEncoding('hex'));
    // Prints: true

    console.log(Buffer.isEncoding('utf/8'));
    // Prints: false

    console.log(Buffer.isEncoding(''));
    // Prints: false
-
    -
    since

    v0.9.1

    -

    Parameters

    • encoding: string
      -

      A character encoding name to check.

      -

    Returns encoding is BufferEncoding

of

  • -

    Creates a new Buffer using the passed {data}

    -

    Parameters

    • Rest ...items: number[]

    Returns <internal>.Buffer

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.CallSite.html b/docs/interfaces/_internal_.CallSite.html deleted file mode 100644 index bd75e99..0000000 --- a/docs/interfaces/_internal_.CallSite.html +++ /dev/null @@ -1,34 +0,0 @@ -CallSite | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface CallSite

Hierarchy

  • CallSite

Index

Methods

Methods

getColumnNumber

  • getColumnNumber(): null | number
  • -

    Current column number [if this function was defined in a script]

    -

    Returns null | number

getEvalOrigin

  • getEvalOrigin(): undefined | string
  • -

    A call site object representing the location where eval was called -[if this function was created using a call to eval]

    -

    Returns undefined | string

getFileName

  • getFileName(): null | string
  • -

    Name of the script [if this function was defined in a script]

    -

    Returns null | string

getFunction

  • -

    Current function

    -

    Returns undefined | <internal>.Function

getFunctionName

  • getFunctionName(): null | string
  • -

    Name of the current function, typically its name property. -If a name property is not available an attempt will be made to try -to infer a name from the function's context.

    -

    Returns null | string

getLineNumber

  • getLineNumber(): null | number
  • -

    Current line number [if this function was defined in a script]

    -

    Returns null | number

getMethodName

  • getMethodName(): null | string
  • -

    Name of the property [of "this" or one of its prototypes] that holds -the current function

    -

    Returns null | string

getThis

  • getThis(): unknown
  • -

    Value of "this"

    -

    Returns unknown

getTypeName

  • getTypeName(): null | string
  • -

    Type of "this" as a string. -This is the name of the function stored in the constructor field of -"this", if available. Otherwise the object's [[Class]] internal -property.

    -

    Returns null | string

isConstructor

  • isConstructor(): boolean
  • -

    Is this a constructor call?

    -

    Returns boolean

isEval

  • isEval(): boolean
  • -

    Does this call take place in code defined by a call to eval?

    -

    Returns boolean

isNative

  • isNative(): boolean
  • -

    Is this call in native V8 code?

    -

    Returns boolean

isToplevel

  • isToplevel(): boolean
  • -

    Is this a toplevel invocation, that is, is "this" the global object?

    -

    Returns boolean

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ChannelIconInterface.html b/docs/interfaces/_internal_.ChannelIconInterface.html deleted file mode 100644 index 3b305c8..0000000 --- a/docs/interfaces/_internal_.ChannelIconInterface.html +++ /dev/null @@ -1,7 +0,0 @@ -ChannelIconInterface | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChannelIconInterface

Hierarchy

  • ChannelIconInterface

Index

Properties

Properties

height

height: number
-

YouTube Channel Icon Height

-

url

url: string
-

YouTube Channel Icon URL

-

width

width: number
-

YouTube Channel Icon Width

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ChannelJSON.html b/docs/interfaces/_internal_.ChannelJSON.html deleted file mode 100644 index c086002..0000000 --- a/docs/interfaces/_internal_.ChannelJSON.html +++ /dev/null @@ -1,17 +0,0 @@ -ChannelJSON | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ChannelJSON

Hierarchy

  • ChannelJSON

Index

Properties

Properties

Optional artist

artist?: boolean
-

YouTube Channel artist if any.

-

Optional icon

icon?: ChannelIconInterface
-

YouTube Channel Icon data.

-

Optional id

id?: string
-

YouTube Channel ID.

-

Optional name

name?: string
-

YouTube Channel Title

-

Optional subscribers

subscribers?: string
-

YouTube Channel subscribers count.

-

type

type: "playlist" | "channel" | "video"
-

Type of Class [ Channel ]

-

Optional url

url?: string
-

YouTube Channel Url

-

Optional verified

verified?: boolean
-

YouTube Channel Verified status.

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ConnectOpts.html b/docs/interfaces/_internal_.ConnectOpts.html deleted file mode 100644 index 0bf563b..0000000 --- a/docs/interfaces/_internal_.ConnectOpts.html +++ /dev/null @@ -1,5 +0,0 @@ -ConnectOpts | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ConnectOpts

Hierarchy

Index

Properties

Properties

Optional onread

onread?: OnReadOpts
-

If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. -Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will -still be emitted as normal and methods like pause() and resume() will also behave as expected.

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DOMEventTarget.html b/docs/interfaces/_internal_.DOMEventTarget.html deleted file mode 100644 index f089967..0000000 --- a/docs/interfaces/_internal_.DOMEventTarget.html +++ /dev/null @@ -1 +0,0 @@ -DOMEventTarget | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DOMEventTarget

Hierarchy

  • DOMEventTarget

Index

Methods

Methods

addEventListener

  • addEventListener(eventName: string, listener: (...args: any[]) => void, opts?: { once: boolean }): any

  • Parameters

    • eventName: string
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    • Optional opts: { once: boolean }
      • once: boolean

    Returns any

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DataView.html b/docs/interfaces/_internal_.DataView.html deleted file mode 100644 index 59ea8ba..0000000 --- a/docs/interfaces/_internal_.DataView.html +++ /dev/null @@ -1,135 +0,0 @@ -DataView | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DataView

Hierarchy

  • DataView

Index

Properties

Methods

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly buffer

buffer: <internal>.ArrayBuffer

Readonly byteLength

byteLength: number

Readonly byteOffset

byteOffset: number

Methods

getBigInt64

  • getBigInt64(byteOffset: number, littleEndian?: boolean): bigint
  • -

    Gets the BigInt64 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -
    • Optional littleEndian: boolean

    Returns bigint

getBigUint64

  • getBigUint64(byteOffset: number, littleEndian?: boolean): bigint
  • -

    Gets the BigUint64 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -
    • Optional littleEndian: boolean

    Returns bigint

getFloat32

  • getFloat32(byteOffset: number, littleEndian?: boolean): number
  • -

    Gets the Float32 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -
    • Optional littleEndian: boolean

    Returns number

getFloat64

  • getFloat64(byteOffset: number, littleEndian?: boolean): number
  • -

    Gets the Float64 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -
    • Optional littleEndian: boolean

    Returns number

getInt16

  • getInt16(byteOffset: number, littleEndian?: boolean): number
  • -

    Gets the Int16 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -
    • Optional littleEndian: boolean

    Returns number

getInt32

  • getInt32(byteOffset: number, littleEndian?: boolean): number
  • -

    Gets the Int32 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -
    • Optional littleEndian: boolean

    Returns number

getInt8

  • getInt8(byteOffset: number): number
  • -

    Gets the Int8 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -

    Returns number

getUint16

  • getUint16(byteOffset: number, littleEndian?: boolean): number
  • -

    Gets the Uint16 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -
    • Optional littleEndian: boolean

    Returns number

getUint32

  • getUint32(byteOffset: number, littleEndian?: boolean): number
  • -

    Gets the Uint32 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -
    • Optional littleEndian: boolean

    Returns number

getUint8

  • getUint8(byteOffset: number): number
  • -

    Gets the Uint8 value at the specified byte offset from the start of the view. There is -no alignment constraint; multi-byte values may be fetched from any offset.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be retrieved.

      -

    Returns number

setBigInt64

  • setBigInt64(byteOffset: number, value: bigint, littleEndian?: boolean): void
  • -

    Stores a BigInt64 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: bigint
      -

      The value to set.

      -
    • Optional littleEndian: boolean
      -

      If false or undefined, a big-endian value should be written, -otherwise a little-endian value should be written.

      -

    Returns void

setBigUint64

  • setBigUint64(byteOffset: number, value: bigint, littleEndian?: boolean): void
  • -

    Stores a BigUint64 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: bigint
      -

      The value to set.

      -
    • Optional littleEndian: boolean
      -

      If false or undefined, a big-endian value should be written, -otherwise a little-endian value should be written.

      -

    Returns void

setFloat32

  • setFloat32(byteOffset: number, value: number, littleEndian?: boolean): void
  • -

    Stores an Float32 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: number
      -

      The value to set.

      -
    • Optional littleEndian: boolean
      -

      If false or undefined, a big-endian value should be written, -otherwise a little-endian value should be written.

      -

    Returns void

setFloat64

  • setFloat64(byteOffset: number, value: number, littleEndian?: boolean): void
  • -

    Stores an Float64 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: number
      -

      The value to set.

      -
    • Optional littleEndian: boolean
      -

      If false or undefined, a big-endian value should be written, -otherwise a little-endian value should be written.

      -

    Returns void

setInt16

  • setInt16(byteOffset: number, value: number, littleEndian?: boolean): void
  • -

    Stores an Int16 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: number
      -

      The value to set.

      -
    • Optional littleEndian: boolean
      -

      If false or undefined, a big-endian value should be written, -otherwise a little-endian value should be written.

      -

    Returns void

setInt32

  • setInt32(byteOffset: number, value: number, littleEndian?: boolean): void
  • -

    Stores an Int32 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: number
      -

      The value to set.

      -
    • Optional littleEndian: boolean
      -

      If false or undefined, a big-endian value should be written, -otherwise a little-endian value should be written.

      -

    Returns void

setInt8

  • setInt8(byteOffset: number, value: number): void
  • -

    Stores an Int8 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: number
      -

      The value to set.

      -

    Returns void

setUint16

  • setUint16(byteOffset: number, value: number, littleEndian?: boolean): void
  • -

    Stores an Uint16 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: number
      -

      The value to set.

      -
    • Optional littleEndian: boolean
      -

      If false or undefined, a big-endian value should be written, -otherwise a little-endian value should be written.

      -

    Returns void

setUint32

  • setUint32(byteOffset: number, value: number, littleEndian?: boolean): void
  • -

    Stores an Uint32 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: number
      -

      The value to set.

      -
    • Optional littleEndian: boolean
      -

      If false or undefined, a big-endian value should be written, -otherwise a little-endian value should be written.

      -

    Returns void

setUint8

  • setUint8(byteOffset: number, value: number): void
  • -

    Stores an Uint8 value at the specified byte offset from the start of the view.

    -

    Parameters

    • byteOffset: number
      -

      The place in the buffer at which the value should be set.

      -
    • value: number
      -

      The value to set.

      -

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DataViewConstructor.html b/docs/interfaces/_internal_.DataViewConstructor.html deleted file mode 100644 index 25f6a94..0000000 --- a/docs/interfaces/_internal_.DataViewConstructor.html +++ /dev/null @@ -1 +0,0 @@ -DataViewConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DataViewConstructor

Hierarchy

  • DataViewConstructor

Index

Constructors

Properties

Constructors

constructor

  • Parameters

    • buffer: ArrayBufferLike
    • Optional byteOffset: number
    • Optional byteLength: number

    Returns <internal>.DataView

Properties

Readonly prototype

prototype: <internal>.DataView

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Date.html b/docs/interfaces/_internal_.Date.html deleted file mode 100644 index 6763257..0000000 --- a/docs/interfaces/_internal_.Date.html +++ /dev/null @@ -1,185 +0,0 @@ -Date | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Date

-

Enables basic storage and retrieval of dates and times.

-

Hierarchy

  • Date

Index

Methods

Methods

[toPrimitive]

  • [toPrimitive](hint: "default"): string
  • [toPrimitive](hint: "string"): string
  • [toPrimitive](hint: "number"): number
  • [toPrimitive](hint: string): string | number
  • -

    Converts a Date object to a string.

    -

    Parameters

    • hint: "default"

    Returns string

  • -

    Converts a Date object to a string.

    -

    Parameters

    • hint: "string"

    Returns string

  • -

    Converts a Date object to a number.

    -

    Parameters

    • hint: "number"

    Returns number

  • -

    Converts a Date object to a string or number.

    -
    throws

    {TypeError} If 'hint' was given something other than "number", "string", or "default".

    -

    Parameters

    • hint: string
      -

      The strings "number", "string", or "default" to specify what primitive to return.

      -

    Returns string | number

    A number if 'hint' was "number", a string if 'hint' was "string" or "default".

    -

getDate

  • getDate(): number
  • -

    Gets the day-of-the-month, using local time.

    -

    Returns number

getDay

  • getDay(): number
  • -

    Gets the day of the week, using local time.

    -

    Returns number

getFullYear

  • getFullYear(): number
  • -

    Gets the year, using local time.

    -

    Returns number

getHours

  • getHours(): number
  • -

    Gets the hours in a date, using local time.

    -

    Returns number

getMilliseconds

  • getMilliseconds(): number
  • -

    Gets the milliseconds of a Date, using local time.

    -

    Returns number

getMinutes

  • getMinutes(): number
  • -

    Gets the minutes of a Date object, using local time.

    -

    Returns number

getMonth

  • getMonth(): number
  • -

    Gets the month, using local time.

    -

    Returns number

getSeconds

  • getSeconds(): number
  • -

    Gets the seconds of a Date object, using local time.

    -

    Returns number

getTime

  • getTime(): number
  • -

    Gets the time value in milliseconds.

    -

    Returns number

getTimezoneOffset

  • getTimezoneOffset(): number
  • -

    Gets the difference in minutes between the time on the local computer and Universal Coordinated Time (UTC).

    -

    Returns number

getUTCDate

  • getUTCDate(): number
  • -

    Gets the day-of-the-month, using Universal Coordinated Time (UTC).

    -

    Returns number

getUTCDay

  • getUTCDay(): number
  • -

    Gets the day of the week using Universal Coordinated Time (UTC).

    -

    Returns number

getUTCFullYear

  • getUTCFullYear(): number
  • -

    Gets the year using Universal Coordinated Time (UTC).

    -

    Returns number

getUTCHours

  • getUTCHours(): number
  • -

    Gets the hours value in a Date object using Universal Coordinated Time (UTC).

    -

    Returns number

getUTCMilliseconds

  • getUTCMilliseconds(): number
  • -

    Gets the milliseconds of a Date object using Universal Coordinated Time (UTC).

    -

    Returns number

getUTCMinutes

  • getUTCMinutes(): number
  • -

    Gets the minutes of a Date object using Universal Coordinated Time (UTC).

    -

    Returns number

getUTCMonth

  • getUTCMonth(): number
  • -

    Gets the month of a Date object using Universal Coordinated Time (UTC).

    -

    Returns number

getUTCSeconds

  • getUTCSeconds(): number
  • -

    Gets the seconds of a Date object using Universal Coordinated Time (UTC).

    -

    Returns number

setDate

  • setDate(date: number): number
  • -

    Sets the numeric day-of-the-month value of the Date object using local time.

    -

    Parameters

    • date: number
      -

      A numeric value equal to the day of the month.

      -

    Returns number

setFullYear

  • setFullYear(year: number, month?: number, date?: number): number
  • -

    Sets the year of the Date object using local time.

    -

    Parameters

    • year: number
      -

      A numeric value for the year.

      -
    • Optional month: number
      -

      A zero-based numeric value for the month (0 for January, 11 for December). Must be specified if numDate is specified.

      -
    • Optional date: number
      -

      A numeric value equal for the day of the month.

      -

    Returns number

setHours

  • setHours(hours: number, min?: number, sec?: number, ms?: number): number
  • -

    Sets the hour value in the Date object using local time.

    -

    Parameters

    • hours: number
      -

      A numeric value equal to the hours value.

      -
    • Optional min: number
      -

      A numeric value equal to the minutes value.

      -
    • Optional sec: number
      -

      A numeric value equal to the seconds value.

      -
    • Optional ms: number
      -

      A numeric value equal to the milliseconds value.

      -

    Returns number

setMilliseconds

  • setMilliseconds(ms: number): number
  • -

    Sets the milliseconds value in the Date object using local time.

    -

    Parameters

    • ms: number
      -

      A numeric value equal to the millisecond value.

      -

    Returns number

setMinutes

  • setMinutes(min: number, sec?: number, ms?: number): number
  • -

    Sets the minutes value in the Date object using local time.

    -

    Parameters

    • min: number
      -

      A numeric value equal to the minutes value.

      -
    • Optional sec: number
      -

      A numeric value equal to the seconds value.

      -
    • Optional ms: number
      -

      A numeric value equal to the milliseconds value.

      -

    Returns number

setMonth

  • setMonth(month: number, date?: number): number
  • -

    Sets the month value in the Date object using local time.

    -

    Parameters

    • month: number
      -

      A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.

      -
    • Optional date: number
      -

      A numeric value representing the day of the month. If this value is not supplied, the value from a call to the getDate method is used.

      -

    Returns number

setSeconds

  • setSeconds(sec: number, ms?: number): number
  • -

    Sets the seconds value in the Date object using local time.

    -

    Parameters

    • sec: number
      -

      A numeric value equal to the seconds value.

      -
    • Optional ms: number
      -

      A numeric value equal to the milliseconds value.

      -

    Returns number

setTime

  • setTime(time: number): number
  • -

    Sets the date and time value in the Date object.

    -

    Parameters

    • time: number
      -

      A numeric value representing the number of elapsed milliseconds since midnight, January 1, 1970 GMT.

      -

    Returns number

setUTCDate

  • setUTCDate(date: number): number
  • -

    Sets the numeric day of the month in the Date object using Universal Coordinated Time (UTC).

    -

    Parameters

    • date: number
      -

      A numeric value equal to the day of the month.

      -

    Returns number

setUTCFullYear

  • setUTCFullYear(year: number, month?: number, date?: number): number
  • -

    Sets the year value in the Date object using Universal Coordinated Time (UTC).

    -

    Parameters

    • year: number
      -

      A numeric value equal to the year.

      -
    • Optional month: number
      -

      A numeric value equal to the month. The value for January is 0, and other month values follow consecutively. Must be supplied if numDate is supplied.

      -
    • Optional date: number
      -

      A numeric value equal to the day of the month.

      -

    Returns number

setUTCHours

  • setUTCHours(hours: number, min?: number, sec?: number, ms?: number): number
  • -

    Sets the hours value in the Date object using Universal Coordinated Time (UTC).

    -

    Parameters

    • hours: number
      -

      A numeric value equal to the hours value.

      -
    • Optional min: number
      -

      A numeric value equal to the minutes value.

      -
    • Optional sec: number
      -

      A numeric value equal to the seconds value.

      -
    • Optional ms: number
      -

      A numeric value equal to the milliseconds value.

      -

    Returns number

setUTCMilliseconds

  • setUTCMilliseconds(ms: number): number
  • -

    Sets the milliseconds value in the Date object using Universal Coordinated Time (UTC).

    -

    Parameters

    • ms: number
      -

      A numeric value equal to the millisecond value.

      -

    Returns number

setUTCMinutes

  • setUTCMinutes(min: number, sec?: number, ms?: number): number
  • -

    Sets the minutes value in the Date object using Universal Coordinated Time (UTC).

    -

    Parameters

    • min: number
      -

      A numeric value equal to the minutes value.

      -
    • Optional sec: number
      -

      A numeric value equal to the seconds value.

      -
    • Optional ms: number
      -

      A numeric value equal to the milliseconds value.

      -

    Returns number

setUTCMonth

  • setUTCMonth(month: number, date?: number): number
  • -

    Sets the month value in the Date object using Universal Coordinated Time (UTC).

    -

    Parameters

    • month: number
      -

      A numeric value equal to the month. The value for January is 0, and other month values follow consecutively.

      -
    • Optional date: number
      -

      A numeric value representing the day of the month. If it is not supplied, the value from a call to the getUTCDate method is used.

      -

    Returns number

setUTCSeconds

  • setUTCSeconds(sec: number, ms?: number): number
  • -

    Sets the seconds value in the Date object using Universal Coordinated Time (UTC).

    -

    Parameters

    • sec: number
      -

      A numeric value equal to the seconds value.

      -
    • Optional ms: number
      -

      A numeric value equal to the milliseconds value.

      -

    Returns number

toDateString

  • toDateString(): string
  • -

    Returns a date as a string value.

    -

    Returns string

toISOString

  • toISOString(): string
  • -

    Returns a date as a string value in ISO format.

    -

    Returns string

toJSON

  • toJSON(key?: any): string
  • -

    Used by the JSON.stringify method to enable the transformation of an object's data for JavaScript Object Notation (JSON) serialization.

    -

    Parameters

    • Optional key: any

    Returns string

toLocaleDateString

  • toLocaleDateString(): string
  • toLocaleDateString(locales?: string | string[], options?: DateTimeFormatOptions): string
  • -

    Returns a date as a string value appropriate to the host environment's current locale.

    -

    Returns string

  • -

    Converts a date to a string by using the current or specified locale.

    -

    Parameters

    • Optional locales: string | string[]
      -

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      -
    • Optional options: DateTimeFormatOptions
      -

      An object that contains one or more properties that specify comparison options.

      -

    Returns string

toLocaleString

  • toLocaleString(): string
  • toLocaleString(locales?: string | string[], options?: DateTimeFormatOptions): string
  • -

    Returns a value as a string value appropriate to the host environment's current locale.

    -

    Returns string

  • -

    Converts a date and time to a string by using the current or specified locale.

    -

    Parameters

    • Optional locales: string | string[]
      -

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      -
    • Optional options: DateTimeFormatOptions
      -

      An object that contains one or more properties that specify comparison options.

      -

    Returns string

toLocaleTimeString

  • toLocaleTimeString(): string
  • toLocaleTimeString(locales?: string | string[], options?: DateTimeFormatOptions): string
  • -

    Returns a time as a string value appropriate to the host environment's current locale.

    -

    Returns string

  • -

    Converts a time to a string by using the current or specified locale.

    -

    Parameters

    • Optional locales: string | string[]
      -

      A locale string or array of locale strings that contain one or more language or locale tags. If you include more than one locale string, list them in descending order of priority so that the first entry is the preferred locale. If you omit this parameter, the default locale of the JavaScript runtime is used.

      -
    • Optional options: DateTimeFormatOptions
      -

      An object that contains one or more properties that specify comparison options.

      -

    Returns string

toString

  • toString(): string
  • -

    Returns a string representation of a date. The format of the string depends on the locale.

    -

    Returns string

toTimeString

  • toTimeString(): string
  • -

    Returns a time as a string value.

    -

    Returns string

toUTCString

  • toUTCString(): string
  • -

    Returns a date converted to a string using Universal Coordinated Time (UTC).

    -

    Returns string

valueOf

  • valueOf(): number
  • -

    Returns the stored time value in milliseconds since midnight, January 1, 1970 UTC.

    -

    Returns number

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DateConstructor.html b/docs/interfaces/_internal_.DateConstructor.html deleted file mode 100644 index ed2d012..0000000 --- a/docs/interfaces/_internal_.DateConstructor.html +++ /dev/null @@ -1,21 +0,0 @@ -DateConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DateConstructor

Hierarchy

  • DateConstructor

Callable

  • DateConstructor(): string

  • Returns string

Index

Constructors

Properties

Methods

Constructors

constructor

  • Returns <internal>.Date

  • Parameters

    • value: string | number

    Returns <internal>.Date

  • Parameters

    • year: number
    • month: number
    • Optional date: number
    • Optional hours: number
    • Optional minutes: number
    • Optional seconds: number
    • Optional ms: number

    Returns <internal>.Date

  • Parameters

    Returns <internal>.Date

Properties

Readonly prototype

prototype: <internal>.Date

Methods

UTC

  • UTC(year: number, month: number, date?: number, hours?: number, minutes?: number, seconds?: number, ms?: number): number
  • -

    Returns the number of milliseconds between midnight, January 1, 1970 Universal Coordinated Time (UTC) (or GMT) and the specified date.

    -

    Parameters

    • year: number
      -

      The full year designation is required for cross-century date accuracy. If year is between 0 and 99 is used, then year is assumed to be 1900 + year.

      -
    • month: number
      -

      The month as a number between 0 and 11 (January to December).

      -
    • Optional date: number
      -

      The date as a number between 1 and 31.

      -
    • Optional hours: number
      -

      Must be supplied if minutes is supplied. A number from 0 to 23 (midnight to 11pm) that specifies the hour.

      -
    • Optional minutes: number
      -

      Must be supplied if seconds is supplied. A number from 0 to 59 that specifies the minutes.

      -
    • Optional seconds: number
      -

      Must be supplied if milliseconds is supplied. A number from 0 to 59 that specifies the seconds.

      -
    • Optional ms: number
      -

      A number from 0 to 999 that specifies the milliseconds.

      -

    Returns number

now

  • now(): number

  • Returns number

parse

  • parse(s: string): number
  • -

    Parses a string containing a date, and returns the number of milliseconds between that date and midnight, January 1, 1970.

    -

    Parameters

    • s: string
      -

      A date string

      -

    Returns number

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DateTimeFormatOptions.html b/docs/interfaces/_internal_.DateTimeFormatOptions.html deleted file mode 100644 index 8cd7ae2..0000000 --- a/docs/interfaces/_internal_.DateTimeFormatOptions.html +++ /dev/null @@ -1 +0,0 @@ -DateTimeFormatOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DateTimeFormatOptions

Hierarchy

  • DateTimeFormatOptions

Index

Properties

Properties

Optional calendar

calendar?: string

Optional dateStyle

dateStyle?: "long" | "short" | "full" | "medium"

Optional day

day?: "numeric" | "2-digit"

Optional dayPeriod

dayPeriod?: "long" | "short" | "narrow"

Optional era

era?: "long" | "short" | "narrow"

Optional formatMatcher

formatMatcher?: "best fit" | "basic"

Optional fractionalSecondDigits

fractionalSecondDigits?: 0 | 1 | 3 | 2

Optional hour

hour?: "numeric" | "2-digit"

Optional hour12

hour12?: boolean

Optional hourCycle

hourCycle?: "h11" | "h12" | "h23" | "h24"

Optional localeMatcher

localeMatcher?: "lookup" | "best fit"

Optional minute

minute?: "numeric" | "2-digit"

Optional month

month?: "long" | "short" | "narrow" | "numeric" | "2-digit"

Optional numberingSystem

numberingSystem?: string

Optional second

second?: "numeric" | "2-digit"

Optional timeStyle

timeStyle?: "long" | "short" | "full" | "medium"

Optional timeZone

timeZone?: string

Optional timeZoneName

timeZoneName?: "long" | "short"

Optional weekday

weekday?: "long" | "short" | "narrow"

Optional year

year?: "numeric" | "2-digit"

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DeezerAdvancedSearchOptions.html b/docs/interfaces/_internal_.DeezerAdvancedSearchOptions.html deleted file mode 100644 index d8865dd..0000000 --- a/docs/interfaces/_internal_.DeezerAdvancedSearchOptions.html +++ /dev/null @@ -1 +0,0 @@ -DeezerAdvancedSearchOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerAdvancedSearchOptions

Hierarchy

  • DeezerAdvancedSearchOptions

Index

Properties

Properties

Optional album

album?: string

Optional artist

artist?: string

Optional label

label?: string

Optional limit

limit?: number

Optional maxBPM

maxBPM?: number

Optional maxDurationInSec

maxDurationInSec?: number

Optional minBPM

minBPM?: number

Optional minDurationInSec

minDurationInSec?: number

Optional title

title?: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DeezerGenre.html b/docs/interfaces/_internal_.DeezerGenre.html deleted file mode 100644 index ea9d8d0..0000000 --- a/docs/interfaces/_internal_.DeezerGenre.html +++ /dev/null @@ -1 +0,0 @@ -DeezerGenre | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerGenre

Hierarchy

  • DeezerGenre

Index

Properties

Properties

name

name: string

picture

picture: DeezerImage

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DeezerImage.html b/docs/interfaces/_internal_.DeezerImage.html deleted file mode 100644 index ddd698b..0000000 --- a/docs/interfaces/_internal_.DeezerImage.html +++ /dev/null @@ -1 +0,0 @@ -DeezerImage | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerImage

Hierarchy

  • DeezerImage

Index

Properties

Properties

big

big: string

medium

medium: string

small

small: string

xl

xl: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.DeezerUser.html b/docs/interfaces/_internal_.DeezerUser.html deleted file mode 100644 index 9a71542..0000000 --- a/docs/interfaces/_internal_.DeezerUser.html +++ /dev/null @@ -1 +0,0 @@ -DeezerUser | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface DeezerUser

Hierarchy

  • DeezerUser

Index

Properties

Properties

id

id: number

name

name: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Dict.html b/docs/interfaces/_internal_.Dict.html deleted file mode 100644 index fbc80f5..0000000 --- a/docs/interfaces/_internal_.Dict.html +++ /dev/null @@ -1 +0,0 @@ -Dict | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Dict<T>

Type parameters

  • T

Hierarchy

Indexable

[key: string]: T | undefined

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ErrnoException.html b/docs/interfaces/_internal_.ErrnoException.html deleted file mode 100644 index 602c148..0000000 --- a/docs/interfaces/_internal_.ErrnoException.html +++ /dev/null @@ -1 +0,0 @@ -ErrnoException | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ErrnoException

Hierarchy

Index

Properties

Properties

Optional code

code?: string

Optional errno

errno?: number

message

message: string

name

name: string

Optional path

path?: string

Optional stack

stack?: string

Optional syscall

syscall?: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Error.html b/docs/interfaces/_internal_.Error.html deleted file mode 100644 index 13289bb..0000000 --- a/docs/interfaces/_internal_.Error.html +++ /dev/null @@ -1 +0,0 @@ -Error | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Error

Hierarchy

  • Error

Index

Properties

Properties

message

message: string

name

name: string

Optional stack

stack?: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ErrorConstructor.html b/docs/interfaces/_internal_.ErrorConstructor.html deleted file mode 100644 index 2fe88ad..0000000 --- a/docs/interfaces/_internal_.ErrorConstructor.html +++ /dev/null @@ -1,6 +0,0 @@ -ErrorConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ErrorConstructor

Hierarchy

  • ErrorConstructor

Callable

  • Parameters

    • Optional message: string

    Returns <internal>.Error

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional message: string

    Returns <internal>.Error

Properties

Optional prepareStackTrace

prepareStackTrace?: (err: <internal>.Error, stackTraces: CallSite[]) => any

Type declaration

Readonly prototype

prototype: <internal>.Error

stackTraceLimit

stackTraceLimit: number

Methods

captureStackTrace

  • -

    Create .stack property on a target object

    -

    Parameters

    Returns void

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.EventEmitter-2.html b/docs/interfaces/_internal_.EventEmitter-2.html deleted file mode 100644 index d1da4bf..0000000 --- a/docs/interfaces/_internal_.EventEmitter-2.html +++ /dev/null @@ -1,135 +0,0 @@ -EventEmitter | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventEmitter

Hierarchy

Index

Methods

Methods

addListener

  • -

    Alias for emitter.on(eventName, listener).

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

emit

  • emit(eventName: string | symbol, ...args: any[]): boolean
  • -

    Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

    -

    Returns true if the event had listeners, false otherwise.

    -
    const EventEmitter = require('events');
    const myEmitter = new EventEmitter();

    // First listener
    myEmitter.on('event', function firstListener() {
      console.log('Helloooo! first listener');
    });
    // Second listener
    myEmitter.on('event', function secondListener(arg1, arg2) {
      console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
    });
    // Third listener
    myEmitter.on('event', function thirdListener(...args) {
      const parameters = args.join(', ');
      console.log(`event with parameters ${parameters} in third listener`);
    });

    console.log(myEmitter.listeners('event'));

    myEmitter.emit('event', 1, 2, 3, 4, 5);

    // Prints:
    // [
    //   [Function: firstListener],
    //   [Function: secondListener],
    //   [Function: thirdListener]
    // ]
    // Helloooo! first listener
    // event with parameters 1, 2 in second listener
    // event with parameters 1, 2, 3, 4, 5 in third listener
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • Rest ...args: any[]

    Returns boolean

eventNames

  • eventNames(): (string | symbol)[]
  • -

    Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

    -
    const EventEmitter = require('events');
    const myEE = new EventEmitter();
    myEE.on('foo', () => {});
    myEE.on('bar', () => {});

    const sym = Symbol('symbol');
    myEE.on(sym, () => {});

    console.log(myEE.eventNames());
    // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
    -
    since

    v6.0.0

    -

    Returns (string | symbol)[]

getMaxListeners

  • getMaxListeners(): number
  • -

    Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

    -
    since

    v1.0.0

    -

    Returns number

listenerCount

  • listenerCount(eventName: string | symbol): number
  • -

    Returns the number of listeners listening to the event named eventName.

    -
    since

    v3.2.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event being listened for

      -

    Returns number

listeners

  • -

    Returns a copy of the array of listeners for the event named eventName.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
    console.log(util.inspect(server.listeners('connection')));
    // Prints: [ [Function] ]
-
    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

off

  • -

    Alias for emitter.removeListener().

    -
    since

    v10.0.0

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

on

  • -

    Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.on('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.on('foo', () => console.log('a'));
    myEE.prependListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.1.101

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

once

  • -

    Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

    -
    server.once('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -

    By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

    -
    const myEE = new EventEmitter();
    myEE.once('foo', () => console.log('a'));
    myEE.prependOnceListener('foo', () => console.log('b'));
    myEE.emit('foo');
    // Prints:
    //   b
    //   a
-
    -
    since

    v0.3.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

prependListener

  • -

    Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

    -
    server.prependListener('connection', (stream) => {
      console.log('someone connected!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

prependOnceListener

  • -

    Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

    -
    server.prependOnceListener('connection', (stream) => {
      console.log('Ah, we have our first user!');
    });
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v6.0.0

    -

    Parameters

    • eventName: string | symbol
      -

      The name of the event.

      -
    • listener: (...args: any[]) => void
      -

      The callback function

      -
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

rawListeners

  • -

    Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

    -
    const emitter = new EventEmitter();
    emitter.once('log', () => console.log('log once'));

    // Returns a new Array with a function `onceWrapper` which has a property
    // `listener` which contains the original listener bound above
    const listeners = emitter.rawListeners('log');
    const logFnWrapper = listeners[0];

    // Logs "log once" to the console and does not unbind the `once` event
    logFnWrapper.listener();

    // Logs "log once" to the console and removes the listener
    logFnWrapper();

    emitter.on('log', () => console.log('log persistently'));
    // Will return a new Array with a single function bound by `.on()` above
    const newListeners = emitter.rawListeners('log');

    // Logs "log persistently" twice
    newListeners[0]();
    emitter.emit('log');
-
    -
    since

    v9.4.0

    -

    Parameters

    • eventName: string | symbol

    Returns <internal>.Function[]

removeAllListeners

  • -

    Removes all listeners, or those of the specified eventName.

    -

    It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • Optional event: string | symbol

    Returns <internal>.EventEmitter

removeListener

  • -

    Removes the specified listener from the listener array for the event namedeventName.

    -
    const callback = (stream) => {
      console.log('someone connected!');
    };
    server.on('connection', callback);
    // ...
    server.removeListener('connection', callback);
-
    -

    removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

    -

    Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

    -
    const myEmitter = new MyEmitter();

    const callbackA = () => {
      console.log('A');
      myEmitter.removeListener('event', callbackB);
    };

    const callbackB = () => {
      console.log('B');
    };

    myEmitter.on('event', callbackA);

    myEmitter.on('event', callbackB);

    // callbackA removes listener callbackB but it will still be called.
    // Internal listener array at time of emit [callbackA, callbackB]
    myEmitter.emit('event');
    // Prints:
    //   A
    //   B

    // callbackB is now removed.
    // Internal listener array [callbackA]
    myEmitter.emit('event');
    // Prints:
    //   A
-
    -

    Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

    -

    When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

    -
    const ee = new EventEmitter();

    function pong() {
      console.log('pong');
    }

    ee.on('ping', pong);
    ee.once('ping', pong);
    ee.removeListener('ping', pong);

    ee.emit('ping');
    ee.emit('ping');
-
    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.1.26

    -

    Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns <internal>.EventEmitter

setMaxListeners

  • -

    By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

    -

    Returns a reference to the EventEmitter, so that calls can be chained.

    -
    since

    v0.3.5

    -

    Parameters

    • n: number

    Returns <internal>.EventEmitter

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.EventEmitter.Abortable.html b/docs/interfaces/_internal_.EventEmitter.Abortable.html deleted file mode 100644 index cd55198..0000000 --- a/docs/interfaces/_internal_.EventEmitter.Abortable.html +++ /dev/null @@ -1,3 +0,0 @@ -Abortable | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Abortable

Hierarchy

Index

Properties

Properties

Optional signal

signal?: <internal>.AbortSignal
-

When provided the corresponding AbortController can be used to cancel an asynchronous action.

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.EventEmitterOptions.html b/docs/interfaces/_internal_.EventEmitterOptions.html deleted file mode 100644 index b58d343..0000000 --- a/docs/interfaces/_internal_.EventEmitterOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -EventEmitterOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EventEmitterOptions

Hierarchy

  • EventEmitterOptions

Index

Properties

Properties

Optional captureRejections

captureRejections?: boolean
-

Enables automatic capturing of promise rejection.

-

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Float32Array.html b/docs/interfaces/_internal_.Float32Array.html deleted file mode 100644 index cbf5ba0..0000000 --- a/docs/interfaces/_internal_.Float32Array.html +++ /dev/null @@ -1,204 +0,0 @@ -Float32Array | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Float32Array

-

A typed array of 32-bit float values. The contents are initialized to 0. If the requested number -of bytes could not be allocated an exception is raised.

-

Hierarchy

Indexable

[index: number]: number

Index

Properties

Methods

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "Float32Array"

Readonly buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number
-

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Readonly length

length: number
-

The length of the array.

-

Methods

[iterator]

  • Returns IterableIterator<number>

at

  • at(index: number): undefined | number
  • -

    Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | number

copyWithin

  • -

    Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

    -

    Parameters

    • target: number
      -

      If target is negative, it is treated as length+target where length is the -length of the array.

      -
    • start: number
      -

      If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

      -
    • Optional end: number
      -

      If not specified, length of the this object is used as its default value.

      -

    Returns <internal>.Float32Array

entries

  • -

    Returns an array of key, value pairs for every entry in the array

    -

    Returns IterableIterator<[number, number]>

every

  • every(predicate: (value: number, index: number, array: <internal>.Float32Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether all the members of an array satisfy the specified test.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Float32Array) => unknown
      -

      A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

fill

  • -

    Changes all array elements from start to end index to a static value and returns the modified array

    -

    Parameters

    • value: number
      -

      value to fill array section with

      -
    • Optional start: number
      -

      index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

      -
    • Optional end: number
      -

      index to stop filling the array at. If end is negative, it is treated as -length+end.

      -

    Returns <internal>.Float32Array

filter

  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Float32Array) => any
      -

      A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Float32Array

find

  • find(predicate: (value: number, index: number, obj: <internal>.Float32Array) => boolean, thisArg?: any): undefined | number
  • -

    Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Float32Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns undefined | number

findIndex

  • findIndex(predicate: (value: number, index: number, obj: <internal>.Float32Array) => boolean, thisArg?: any): number
  • -

    Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Float32Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns number

forEach

  • forEach(callbackfn: (value: number, index: number, array: <internal>.Float32Array) => void, thisArg?: any): void
  • -

    Performs the specified action for each element in an array.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Float32Array) => void
      -

      A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean
  • -

    Determines whether an array includes a certain element, returning true or false as appropriate.

    -

    Parameters

    • searchElement: number
      -

      The element to search for.

      -
    • Optional fromIndex: number
      -

      The position in this array at which to begin searching for searchElement.

      -

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the first occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

      -

    Returns number

join

  • join(separator?: string): string
  • -

    Adds all the elements of an array separated by the specified separator string.

    -

    Parameters

    • Optional separator: string
      -

      A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

      -

    Returns string

keys

  • -

    Returns an list of keys in the array

    -

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the last occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

map

  • -

    Calls a defined callback function on each element of an array, and returns an array that -contains the results.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Float32Array) => number
      -

      A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Float32Array

reduce

  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => number): number
  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => number, initialValue: number): number
  • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => number
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => U
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => number): number
  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => number, initialValue: number): number
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => number
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Float32Array) => U
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reverse

  • -

    Reverses the elements in an Array.

    -

    Returns <internal>.Float32Array

set

  • set(array: ArrayLike<number>, offset?: number): void
  • -

    Sets a value or an array of values.

    -

    Parameters

    • array: ArrayLike<number>
      -

      A typed or untyped array of values to set.

      -
    • Optional offset: number
      -

      The index in the current array at which the values are to be written.

      -

    Returns void

slice

  • -

    Returns a section of an array.

    -

    Parameters

    • Optional start: number
      -

      The beginning of the specified portion of the array.

      -
    • Optional end: number
      -

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      -

    Returns <internal>.Float32Array

some

  • some(predicate: (value: number, index: number, array: <internal>.Float32Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether the specified callback function returns true for any element of an array.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Float32Array) => unknown
      -

      A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

sort

  • -

    Sorts an array.

    -

    Parameters

    • Optional compareFn: (a: number, b: number) => number
      -

      Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      -
      [11,2,22,1].sort((a, b) => a - b)
-
      -
        • (a: number, b: number): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns <internal>.Float32Array

subarray

  • -

    Gets a new Float32Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

    -

    Parameters

    • Optional begin: number
      -

      The index of the beginning of the array.

      -
    • Optional end: number
      -

      The index of the end of the array.

      -

    Returns <internal>.Float32Array

toLocaleString

  • toLocaleString(): string
  • -

    Converts a number to a string by using the current locale.

    -

    Returns string

toString

  • toString(): string
  • -

    Returns a string representation of an array.

    -

    Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.Float32Array

values

  • -

    Returns an list of values in the array

    -

    Returns IterableIterator<number>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Float32ArrayConstructor.html b/docs/interfaces/_internal_.Float32ArrayConstructor.html deleted file mode 100644 index 6797b9f..0000000 --- a/docs/interfaces/_internal_.Float32ArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Float32ArrayConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Float32ArrayConstructor

Hierarchy

  • Float32ArrayConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly prototype

prototype: <internal>.Float32Array

Methods

from

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: ArrayLike<number>
      -

      An array-like or iterable object to convert to an array.

      -

    Returns <internal>.Float32Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Type parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>
      -

      An array-like or iterable object to convert to an array.

      -
    • mapfn: (v: T, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: T, k: number): number

        • Parameters

          • v: T
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Float32Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: Iterable<number>
      -

      An array-like or iterable object to convert to an array.

      -
    • Optional mapfn: (v: number, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: number, k: number): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Float32Array

of

  • -

    Returns a new array from a set of elements.

    -

    Parameters

    • Rest ...items: number[]
      -

      A set of elements to include in the new array object.

      -

    Returns <internal>.Float32Array

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Float64Array.html b/docs/interfaces/_internal_.Float64Array.html deleted file mode 100644 index d9fd67a..0000000 --- a/docs/interfaces/_internal_.Float64Array.html +++ /dev/null @@ -1,199 +0,0 @@ -Float64Array | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Float64Array

-

A typed array of 64-bit float values. The contents are initialized to 0. If the requested -number of bytes could not be allocated an exception is raised.

-

Hierarchy

Indexable

[index: number]: number

Index

Properties

Methods

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "Float64Array"

Readonly buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number
-

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Readonly length

length: number
-

The length of the array.

-

Methods

[iterator]

  • Returns IterableIterator<number>

at

  • at(index: number): undefined | number
  • -

    Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | number

copyWithin

  • -

    Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

    -

    Parameters

    • target: number
      -

      If target is negative, it is treated as length+target where length is the -length of the array.

      -
    • start: number
      -

      If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

      -
    • Optional end: number
      -

      If not specified, length of the this object is used as its default value.

      -

    Returns <internal>.Float64Array

entries

  • -

    Returns an array of key, value pairs for every entry in the array

    -

    Returns IterableIterator<[number, number]>

every

  • every(predicate: (value: number, index: number, array: <internal>.Float64Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether all the members of an array satisfy the specified test.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Float64Array) => unknown
      -

      A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

fill

  • -

    Changes all array elements from start to end index to a static value and returns the modified array

    -

    Parameters

    • value: number
      -

      value to fill array section with

      -
    • Optional start: number
      -

      index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

      -
    • Optional end: number
      -

      index to stop filling the array at. If end is negative, it is treated as -length+end.

      -

    Returns <internal>.Float64Array

filter

  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Float64Array) => any
      -

      A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Float64Array

find

  • find(predicate: (value: number, index: number, obj: <internal>.Float64Array) => boolean, thisArg?: any): undefined | number
  • -

    Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Float64Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns undefined | number

findIndex

  • findIndex(predicate: (value: number, index: number, obj: <internal>.Float64Array) => boolean, thisArg?: any): number
  • -

    Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Float64Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns number

forEach

  • forEach(callbackfn: (value: number, index: number, array: <internal>.Float64Array) => void, thisArg?: any): void
  • -

    Performs the specified action for each element in an array.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Float64Array) => void
      -

      A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean
  • -

    Determines whether an array includes a certain element, returning true or false as appropriate.

    -

    Parameters

    • searchElement: number
      -

      The element to search for.

      -
    • Optional fromIndex: number
      -

      The position in this array at which to begin searching for searchElement.

      -

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the first occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

      -

    Returns number

join

  • join(separator?: string): string
  • -

    Adds all the elements of an array separated by the specified separator string.

    -

    Parameters

    • Optional separator: string
      -

      A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

      -

    Returns string

keys

  • -

    Returns an list of keys in the array

    -

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the last occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

map

  • -

    Calls a defined callback function on each element of an array, and returns an array that -contains the results.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Float64Array) => number
      -

      A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Float64Array

reduce

  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => number): number
  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => number, initialValue: number): number
  • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => number
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => U
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => number): number
  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => number, initialValue: number): number
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => number
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Float64Array) => U
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reverse

  • -

    Reverses the elements in an Array.

    -

    Returns <internal>.Float64Array

set

  • set(array: ArrayLike<number>, offset?: number): void
  • -

    Sets a value or an array of values.

    -

    Parameters

    • array: ArrayLike<number>
      -

      A typed or untyped array of values to set.

      -
    • Optional offset: number
      -

      The index in the current array at which the values are to be written.

      -

    Returns void

slice

  • -

    Returns a section of an array.

    -

    Parameters

    • Optional start: number
      -

      The beginning of the specified portion of the array.

      -
    • Optional end: number
      -

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      -

    Returns <internal>.Float64Array

some

  • some(predicate: (value: number, index: number, array: <internal>.Float64Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether the specified callback function returns true for any element of an array.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Float64Array) => unknown
      -

      A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

sort

  • -

    Sorts an array.

    -

    Parameters

    • Optional compareFn: (a: number, b: number) => number
      -

      Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      -
      [11,2,22,1].sort((a, b) => a - b)
-
      -
        • (a: number, b: number): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns <internal>.Float64Array

subarray

  • -

    at begin, inclusive, up to end, exclusive.

    -

    Parameters

    • Optional begin: number
      -

      The index of the beginning of the array.

      -
    • Optional end: number
      -

      The index of the end of the array.

      -

    Returns <internal>.Float64Array

toString

  • toString(): string

  • Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.Float64Array

values

  • -

    Returns an list of values in the array

    -

    Returns IterableIterator<number>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Float64ArrayConstructor.html b/docs/interfaces/_internal_.Float64ArrayConstructor.html deleted file mode 100644 index cf4cc03..0000000 --- a/docs/interfaces/_internal_.Float64ArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Float64ArrayConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Float64ArrayConstructor

Hierarchy

  • Float64ArrayConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly prototype

prototype: <internal>.Float64Array

Methods

from

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: ArrayLike<number>
      -

      An array-like or iterable object to convert to an array.

      -

    Returns <internal>.Float64Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Type parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>
      -

      An array-like or iterable object to convert to an array.

      -
    • mapfn: (v: T, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: T, k: number): number

        • Parameters

          • v: T
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Float64Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: Iterable<number>
      -

      An array-like or iterable object to convert to an array.

      -
    • Optional mapfn: (v: number, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: number, k: number): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Float64Array

of

  • -

    Returns a new array from a set of elements.

    -

    Parameters

    • Rest ...items: number[]
      -

      A set of elements to include in the new array object.

      -

    Returns <internal>.Float64Array

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Function.html b/docs/interfaces/_internal_.Function.html deleted file mode 100644 index 224a4b7..0000000 --- a/docs/interfaces/_internal_.Function.html +++ /dev/null @@ -1,31 +0,0 @@ -Function | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Function

-

Creates a new function.

-

Hierarchy

  • Function

Index

Properties

Methods

Properties

arguments

arguments: any

caller

caller: <internal>.Function

Readonly length

length: number

Readonly name

name: string
-

Returns the name of the function. Function names are read-only and can not be changed.

-

prototype

prototype: any

Methods

[hasInstance]

  • [hasInstance](value: any): boolean
  • -

    Determines whether the given value inherits from this function if this function was used -as a constructor function.

    -

    A constructor function can control which objects are recognized as its instances by -'instanceof' by overriding this method.

    -

    Parameters

    • value: any

    Returns boolean

apply

  • apply(thisArg: any, argArray?: any): any
  • -

    Calls the function, substituting the specified object for the this value of the function, and the specified array for the arguments of the function.

    -

    Parameters

    • thisArg: any
      -

      The object to be used as the this object.

      -
    • Optional argArray: any
      -

      A set of arguments to be passed to the function.

      -

    Returns any

bind

  • bind(thisArg: any, ...argArray: any[]): any
  • -

    For a given function, creates a bound function that has the same body as the original function. -The this object of the bound function is associated with the specified object, and has the specified initial parameters.

    -

    Parameters

    • thisArg: any
      -

      An object to which the this keyword can refer inside the new function.

      -
    • Rest ...argArray: any[]
      -

      A list of arguments to be passed to the new function.

      -

    Returns any

call

  • call(thisArg: any, ...argArray: any[]): any
  • -

    Calls a method of an object, substituting another object for the current object.

    -

    Parameters

    • thisArg: any
      -

      The object to be used as the current object.

      -
    • Rest ...argArray: any[]
      -

      A list of arguments to be passed to the method.

      -

    Returns any

toString

  • toString(): string
  • -

    Returns a string representation of a function.

    -

    Returns string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.FunctionConstructor.html b/docs/interfaces/_internal_.FunctionConstructor.html deleted file mode 100644 index 6e7fc6e..0000000 --- a/docs/interfaces/_internal_.FunctionConstructor.html +++ /dev/null @@ -1,5 +0,0 @@ -FunctionConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface FunctionConstructor

Hierarchy

  • FunctionConstructor

Callable

  • Parameters

    • Rest ...args: string[]

    Returns <internal>.Function

Index

Constructors

Properties

Constructors

constructor

  • -

    Creates a new function.

    -

    Parameters

    • Rest ...args: string[]
      -

      A list of arguments the function accepts.

      -

    Returns <internal>.Function

Properties

Readonly prototype

prototype: <internal>.Function

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.IncomingHttpHeaders.html b/docs/interfaces/_internal_.IncomingHttpHeaders.html deleted file mode 100644 index 45ffec9..0000000 --- a/docs/interfaces/_internal_.IncomingHttpHeaders.html +++ /dev/null @@ -1 +0,0 @@ -IncomingHttpHeaders | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IncomingHttpHeaders

Hierarchy

  • Dict<string | string[]>
    • IncomingHttpHeaders

Index

Properties

Properties

Optional accept

accept?: string

Optional accept-language

accept-language?: string

Optional accept-patch

accept-patch?: string

Optional accept-ranges

accept-ranges?: string

Optional access-control-allow-credentials

access-control-allow-credentials?: string

Optional access-control-allow-headers

access-control-allow-headers?: string

Optional access-control-allow-methods

access-control-allow-methods?: string

Optional access-control-allow-origin

access-control-allow-origin?: string

Optional access-control-expose-headers

access-control-expose-headers?: string

Optional access-control-max-age

access-control-max-age?: string

Optional access-control-request-headers

access-control-request-headers?: string

Optional access-control-request-method

access-control-request-method?: string

Optional age

age?: string

Optional allow

allow?: string

Optional alt-svc

alt-svc?: string

Optional authorization

authorization?: string

Optional cache-control

cache-control?: string

Optional connection

connection?: string

Optional content-disposition

content-disposition?: string

Optional content-encoding

content-encoding?: string

Optional content-language

content-language?: string

Optional content-length

content-length?: string

Optional content-location

content-location?: string

Optional content-range

content-range?: string

Optional content-type

content-type?: string

Optional cookie

cookie?: string

Optional date

date?: string

Optional etag

etag?: string

Optional expect

expect?: string

Optional expires

expires?: string

Optional forwarded

forwarded?: string

Optional from

from?: string

Optional host

host?: string

Optional if-match

if-match?: string

Optional if-modified-since

if-modified-since?: string

Optional if-none-match

if-none-match?: string

Optional if-unmodified-since

if-unmodified-since?: string

Optional last-modified

last-modified?: string

Optional location

location?: string

Optional origin

origin?: string

Optional pragma

pragma?: string

Optional proxy-authenticate

proxy-authenticate?: string

Optional proxy-authorization

proxy-authorization?: string

Optional public-key-pins

public-key-pins?: string

Optional range

range?: string

Optional referer

referer?: string

Optional retry-after

retry-after?: string

Optional sec-websocket-accept

sec-websocket-accept?: string

Optional sec-websocket-extensions

sec-websocket-extensions?: string

Optional sec-websocket-key

sec-websocket-key?: string

Optional sec-websocket-protocol

sec-websocket-protocol?: string

Optional sec-websocket-version

sec-websocket-version?: string

Optional set-cookie

set-cookie?: string[]

Optional strict-transport-security

strict-transport-security?: string

Optional tk

tk?: string

Optional trailer

trailer?: string

Optional transfer-encoding

transfer-encoding?: string

Optional upgrade

upgrade?: string

Optional user-agent

user-agent?: string

Optional vary

vary?: string

Optional via

via?: string

Optional warning

warning?: string

Optional www-authenticate

www-authenticate?: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.InfoData.html b/docs/interfaces/_internal_.InfoData.html deleted file mode 100644 index 4e827af..0000000 --- a/docs/interfaces/_internal_.InfoData.html +++ /dev/null @@ -1 +0,0 @@ -InfoData | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoData

Hierarchy

  • InfoData

Index

Properties

Properties

LiveStreamData

LiveStreamData: LiveStreamData

format

format: Partial<formatData>[]

html5player

html5player: string

related_videos

related_videos: string[]

video_details

video_details: YouTubeVideo

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.InfoOptions.html b/docs/interfaces/_internal_.InfoOptions.html deleted file mode 100644 index 34e8c15..0000000 --- a/docs/interfaces/_internal_.InfoOptions.html +++ /dev/null @@ -1 +0,0 @@ -InfoOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface InfoOptions

Hierarchy

  • InfoOptions

Index

Properties

Properties

Optional htmldata

htmldata?: boolean

Optional proxy

proxy?: ProxyOptions[]

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Int16Array.html b/docs/interfaces/_internal_.Int16Array.html deleted file mode 100644 index 3af4cb2..0000000 --- a/docs/interfaces/_internal_.Int16Array.html +++ /dev/null @@ -1,204 +0,0 @@ -Int16Array | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Int16Array

-

A typed array of 16-bit signed integer values. The contents are initialized to 0. If the -requested number of bytes could not be allocated an exception is raised.

-

Hierarchy

Indexable

[index: number]: number

Index

Properties

Methods

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "Int16Array"

Readonly buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number
-

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Readonly length

length: number
-

The length of the array.

-

Methods

[iterator]

  • Returns IterableIterator<number>

at

  • at(index: number): undefined | number
  • -

    Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | number

copyWithin

  • -

    Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

    -

    Parameters

    • target: number
      -

      If target is negative, it is treated as length+target where length is the -length of the array.

      -
    • start: number
      -

      If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

      -
    • Optional end: number
      -

      If not specified, length of the this object is used as its default value.

      -

    Returns <internal>.Int16Array

entries

  • -

    Returns an array of key, value pairs for every entry in the array

    -

    Returns IterableIterator<[number, number]>

every

  • every(predicate: (value: number, index: number, array: <internal>.Int16Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether all the members of an array satisfy the specified test.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int16Array) => unknown
      -

      A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

fill

  • -

    Changes all array elements from start to end index to a static value and returns the modified array

    -

    Parameters

    • value: number
      -

      value to fill array section with

      -
    • Optional start: number
      -

      index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

      -
    • Optional end: number
      -

      index to stop filling the array at. If end is negative, it is treated as -length+end.

      -

    Returns <internal>.Int16Array

filter

  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int16Array) => any
      -

      A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Int16Array

find

  • find(predicate: (value: number, index: number, obj: <internal>.Int16Array) => boolean, thisArg?: any): undefined | number
  • -

    Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Int16Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns undefined | number

findIndex

  • findIndex(predicate: (value: number, index: number, obj: <internal>.Int16Array) => boolean, thisArg?: any): number
  • -

    Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Int16Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns number

forEach

  • forEach(callbackfn: (value: number, index: number, array: <internal>.Int16Array) => void, thisArg?: any): void
  • -

    Performs the specified action for each element in an array.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Int16Array) => void
      -

      A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean
  • -

    Determines whether an array includes a certain element, returning true or false as appropriate.

    -

    Parameters

    • searchElement: number
      -

      The element to search for.

      -
    • Optional fromIndex: number
      -

      The position in this array at which to begin searching for searchElement.

      -

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the first occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

      -

    Returns number

join

  • join(separator?: string): string
  • -

    Adds all the elements of an array separated by the specified separator string.

    -

    Parameters

    • Optional separator: string
      -

      A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

      -

    Returns string

keys

  • -

    Returns an list of keys in the array

    -

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the last occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

map

  • -

    Calls a defined callback function on each element of an array, and returns an array that -contains the results.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Int16Array) => number
      -

      A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Int16Array

reduce

  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => number): number
  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => number, initialValue: number): number
  • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => number
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array): number

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => number
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array): number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => U
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => number): number
  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => number, initialValue: number): number
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => number
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array): number

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => number
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int16Array): number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int16Array) => U
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reverse

  • -

    Reverses the elements in an Array.

    -

    Returns <internal>.Int16Array

set

  • set(array: ArrayLike<number>, offset?: number): void
  • -

    Sets a value or an array of values.

    -

    Parameters

    • array: ArrayLike<number>
      -

      A typed or untyped array of values to set.

      -
    • Optional offset: number
      -

      The index in the current array at which the values are to be written.

      -

    Returns void

slice

  • -

    Returns a section of an array.

    -

    Parameters

    • Optional start: number
      -

      The beginning of the specified portion of the array.

      -
    • Optional end: number
      -

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      -

    Returns <internal>.Int16Array

some

  • some(predicate: (value: number, index: number, array: <internal>.Int16Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether the specified callback function returns true for any element of an array.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int16Array) => unknown
      -

      A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

sort

  • -

    Sorts an array.

    -

    Parameters

    • Optional compareFn: (a: number, b: number) => number
      -

      Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      -
      [11,2,22,1].sort((a, b) => a - b)
-
      -
        • (a: number, b: number): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns <internal>.Int16Array

subarray

  • -

    Gets a new Int16Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

    -

    Parameters

    • Optional begin: number
      -

      The index of the beginning of the array.

      -
    • Optional end: number
      -

      The index of the end of the array.

      -

    Returns <internal>.Int16Array

toLocaleString

  • toLocaleString(): string
  • -

    Converts a number to a string by using the current locale.

    -

    Returns string

toString

  • toString(): string
  • -

    Returns a string representation of an array.

    -

    Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.Int16Array

values

  • -

    Returns an list of values in the array

    -

    Returns IterableIterator<number>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Int16ArrayConstructor.html b/docs/interfaces/_internal_.Int16ArrayConstructor.html deleted file mode 100644 index 8e1782e..0000000 --- a/docs/interfaces/_internal_.Int16ArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Int16ArrayConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Int16ArrayConstructor

Hierarchy

  • Int16ArrayConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly prototype

prototype: <internal>.Int16Array

Methods

from

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: ArrayLike<number>
      -

      An array-like or iterable object to convert to an array.

      -

    Returns <internal>.Int16Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Type parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>
      -

      An array-like or iterable object to convert to an array.

      -
    • mapfn: (v: T, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: T, k: number): number

        • Parameters

          • v: T
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Int16Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: Iterable<number>
      -

      An array-like or iterable object to convert to an array.

      -
    • Optional mapfn: (v: number, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: number, k: number): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Int16Array

of

  • -

    Returns a new array from a set of elements.

    -

    Parameters

    • Rest ...items: number[]
      -

      A set of elements to include in the new array object.

      -

    Returns <internal>.Int16Array

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Int32Array.html b/docs/interfaces/_internal_.Int32Array.html deleted file mode 100644 index f061aa7..0000000 --- a/docs/interfaces/_internal_.Int32Array.html +++ /dev/null @@ -1,204 +0,0 @@ -Int32Array | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Int32Array

-

A typed array of 32-bit signed integer values. The contents are initialized to 0. If the -requested number of bytes could not be allocated an exception is raised.

-

Hierarchy

Indexable

[index: number]: number

Index

Properties

Methods

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "Int32Array"

Readonly buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number
-

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Readonly length

length: number
-

The length of the array.

-

Methods

[iterator]

  • Returns IterableIterator<number>

at

  • at(index: number): undefined | number
  • -

    Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | number

copyWithin

  • -

    Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

    -

    Parameters

    • target: number
      -

      If target is negative, it is treated as length+target where length is the -length of the array.

      -
    • start: number
      -

      If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

      -
    • Optional end: number
      -

      If not specified, length of the this object is used as its default value.

      -

    Returns <internal>.Int32Array

entries

  • -

    Returns an array of key, value pairs for every entry in the array

    -

    Returns IterableIterator<[number, number]>

every

  • every(predicate: (value: number, index: number, array: <internal>.Int32Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether all the members of an array satisfy the specified test.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int32Array) => unknown
      -

      A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

fill

  • -

    Changes all array elements from start to end index to a static value and returns the modified array

    -

    Parameters

    • value: number
      -

      value to fill array section with

      -
    • Optional start: number
      -

      index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

      -
    • Optional end: number
      -

      index to stop filling the array at. If end is negative, it is treated as -length+end.

      -

    Returns <internal>.Int32Array

filter

  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int32Array) => any
      -

      A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Int32Array

find

  • find(predicate: (value: number, index: number, obj: <internal>.Int32Array) => boolean, thisArg?: any): undefined | number
  • -

    Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Int32Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns undefined | number

findIndex

  • findIndex(predicate: (value: number, index: number, obj: <internal>.Int32Array) => boolean, thisArg?: any): number
  • -

    Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Int32Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns number

forEach

  • forEach(callbackfn: (value: number, index: number, array: <internal>.Int32Array) => void, thisArg?: any): void
  • -

    Performs the specified action for each element in an array.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Int32Array) => void
      -

      A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean
  • -

    Determines whether an array includes a certain element, returning true or false as appropriate.

    -

    Parameters

    • searchElement: number
      -

      The element to search for.

      -
    • Optional fromIndex: number
      -

      The position in this array at which to begin searching for searchElement.

      -

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the first occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

      -

    Returns number

join

  • join(separator?: string): string
  • -

    Adds all the elements of an array separated by the specified separator string.

    -

    Parameters

    • Optional separator: string
      -

      A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

      -

    Returns string

keys

  • -

    Returns an list of keys in the array

    -

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the last occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

map

  • -

    Calls a defined callback function on each element of an array, and returns an array that -contains the results.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Int32Array) => number
      -

      A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Int32Array

reduce

  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => number): number
  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => number, initialValue: number): number
  • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => number
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array): number

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => number
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array): number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => U
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => number): number
  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => number, initialValue: number): number
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => number
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array): number

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => number
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int32Array): number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int32Array) => U
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reverse

  • -

    Reverses the elements in an Array.

    -

    Returns <internal>.Int32Array

set

  • set(array: ArrayLike<number>, offset?: number): void
  • -

    Sets a value or an array of values.

    -

    Parameters

    • array: ArrayLike<number>
      -

      A typed or untyped array of values to set.

      -
    • Optional offset: number
      -

      The index in the current array at which the values are to be written.

      -

    Returns void

slice

  • -

    Returns a section of an array.

    -

    Parameters

    • Optional start: number
      -

      The beginning of the specified portion of the array.

      -
    • Optional end: number
      -

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      -

    Returns <internal>.Int32Array

some

  • some(predicate: (value: number, index: number, array: <internal>.Int32Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether the specified callback function returns true for any element of an array.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int32Array) => unknown
      -

      A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

sort

  • -

    Sorts an array.

    -

    Parameters

    • Optional compareFn: (a: number, b: number) => number
      -

      Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      -
      [11,2,22,1].sort((a, b) => a - b)
-
      -
        • (a: number, b: number): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns <internal>.Int32Array

subarray

  • -

    Gets a new Int32Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

    -

    Parameters

    • Optional begin: number
      -

      The index of the beginning of the array.

      -
    • Optional end: number
      -

      The index of the end of the array.

      -

    Returns <internal>.Int32Array

toLocaleString

  • toLocaleString(): string
  • -

    Converts a number to a string by using the current locale.

    -

    Returns string

toString

  • toString(): string
  • -

    Returns a string representation of an array.

    -

    Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.Int32Array

values

  • -

    Returns an list of values in the array

    -

    Returns IterableIterator<number>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Int32ArrayConstructor.html b/docs/interfaces/_internal_.Int32ArrayConstructor.html deleted file mode 100644 index c043baf..0000000 --- a/docs/interfaces/_internal_.Int32ArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Int32ArrayConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Int32ArrayConstructor

Hierarchy

  • Int32ArrayConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly prototype

prototype: <internal>.Int32Array

Methods

from

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: ArrayLike<number>
      -

      An array-like or iterable object to convert to an array.

      -

    Returns <internal>.Int32Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Type parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>
      -

      An array-like or iterable object to convert to an array.

      -
    • mapfn: (v: T, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: T, k: number): number

        • Parameters

          • v: T
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Int32Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: Iterable<number>
      -

      An array-like or iterable object to convert to an array.

      -
    • Optional mapfn: (v: number, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: number, k: number): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Int32Array

of

  • -

    Returns a new array from a set of elements.

    -

    Parameters

    • Rest ...items: number[]
      -

      A set of elements to include in the new array object.

      -

    Returns <internal>.Int32Array

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Int8Array.html b/docs/interfaces/_internal_.Int8Array.html deleted file mode 100644 index 8b0d4e7..0000000 --- a/docs/interfaces/_internal_.Int8Array.html +++ /dev/null @@ -1,204 +0,0 @@ -Int8Array | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Int8Array

-

A typed array of 8-bit integer values. The contents are initialized to 0. If the requested -number of bytes could not be allocated an exception is raised.

-

Hierarchy

Indexable

[index: number]: number

Index

Properties

Methods

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly [toStringTag]

[toStringTag]: "Int8Array"

Readonly buffer

buffer: ArrayBufferLike
-

The ArrayBuffer instance referenced by the array.

-

Readonly byteLength

byteLength: number
-

The length in bytes of the array.

-

Readonly byteOffset

byteOffset: number
-

The offset in bytes of the array.

-

Readonly length

length: number
-

The length of the array.

-

Methods

[iterator]

  • Returns IterableIterator<number>

at

  • at(index: number): undefined | number
  • -

    Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

    -

    Parameters

    • index: number

    Returns undefined | number

copyWithin

  • -

    Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

    -

    Parameters

    • target: number
      -

      If target is negative, it is treated as length+target where length is the -length of the array.

      -
    • start: number
      -

      If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

      -
    • Optional end: number
      -

      If not specified, length of the this object is used as its default value.

      -

    Returns <internal>.Int8Array

entries

  • -

    Returns an array of key, value pairs for every entry in the array

    -

    Returns IterableIterator<[number, number]>

every

  • every(predicate: (value: number, index: number, array: <internal>.Int8Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether all the members of an array satisfy the specified test.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int8Array) => unknown
      -

      A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

fill

  • -

    Changes all array elements from start to end index to a static value and returns the modified array

    -

    Parameters

    • value: number
      -

      value to fill array section with

      -
    • Optional start: number
      -

      index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

      -
    • Optional end: number
      -

      index to stop filling the array at. If end is negative, it is treated as -length+end.

      -

    Returns <internal>.Int8Array

filter

  • -

    Returns the elements of an array that meet the condition specified in a callback function.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int8Array) => any
      -

      A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Int8Array

find

  • find(predicate: (value: number, index: number, obj: <internal>.Int8Array) => boolean, thisArg?: any): undefined | number
  • -

    Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Int8Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns undefined | number

findIndex

  • findIndex(predicate: (value: number, index: number, obj: <internal>.Int8Array) => boolean, thisArg?: any): number
  • -

    Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

    -

    Parameters

    • predicate: (value: number, index: number, obj: <internal>.Int8Array) => boolean
      -

      find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

      -
    • Optional thisArg: any
      -

      If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

      -

    Returns number

forEach

  • forEach(callbackfn: (value: number, index: number, array: <internal>.Int8Array) => void, thisArg?: any): void
  • -

    Performs the specified action for each element in an array.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Int8Array) => void
      -

      A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns void

includes

  • includes(searchElement: number, fromIndex?: number): boolean
  • -

    Determines whether an array includes a certain element, returning true or false as appropriate.

    -

    Parameters

    • searchElement: number
      -

      The element to search for.

      -
    • Optional fromIndex: number
      -

      The position in this array at which to begin searching for searchElement.

      -

    Returns boolean

indexOf

  • indexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the first occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

      -

    Returns number

join

  • join(separator?: string): string
  • -

    Adds all the elements of an array separated by the specified separator string.

    -

    Parameters

    • Optional separator: string
      -

      A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

      -

    Returns string

keys

  • -

    Returns an list of keys in the array

    -

    Returns IterableIterator<number>

lastIndexOf

  • lastIndexOf(searchElement: number, fromIndex?: number): number
  • -

    Returns the index of the last occurrence of a value in an array.

    -

    Parameters

    • searchElement: number
      -

      The value to locate in the array.

      -
    • Optional fromIndex: number
      -

      The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

      -

    Returns number

map

  • -

    Calls a defined callback function on each element of an array, and returns an array that -contains the results.

    -

    Parameters

    • callbackfn: (value: number, index: number, array: <internal>.Int8Array) => number
      -

      A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns <internal>.Int8Array

reduce

  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => number): number
  • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => number, initialValue: number): number
  • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => number
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array): number

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => number
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array): number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => U
      -

      A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

      -

        • Parameters

          Returns U

    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reduceRight

  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => number): number
  • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => number, initialValue: number): number
  • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => U, initialValue: U): U
  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => number
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array): number

        • Parameters

          Returns number

    Returns number

  • Parameters

    • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => number
        • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Int8Array): number

        • Parameters

          Returns number

    • initialValue: number

    Returns number

  • -

    Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

    -

    Type parameters

    • U

    Parameters

    • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Int8Array) => U
      -

      A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

      -

        • Parameters

          Returns U

    • initialValue: U
      -

      If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

      -

    Returns U

reverse

  • -

    Reverses the elements in an Array.

    -

    Returns <internal>.Int8Array

set

  • set(array: ArrayLike<number>, offset?: number): void
  • -

    Sets a value or an array of values.

    -

    Parameters

    • array: ArrayLike<number>
      -

      A typed or untyped array of values to set.

      -
    • Optional offset: number
      -

      The index in the current array at which the values are to be written.

      -

    Returns void

slice

  • -

    Returns a section of an array.

    -

    Parameters

    • Optional start: number
      -

      The beginning of the specified portion of the array.

      -
    • Optional end: number
      -

      The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

      -

    Returns <internal>.Int8Array

some

  • some(predicate: (value: number, index: number, array: <internal>.Int8Array) => unknown, thisArg?: any): boolean
  • -

    Determines whether the specified callback function returns true for any element of an array.

    -

    Parameters

    • predicate: (value: number, index: number, array: <internal>.Int8Array) => unknown
      -

      A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

      -
    • Optional thisArg: any
      -

      An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

      -

    Returns boolean

sort

  • -

    Sorts an array.

    -

    Parameters

    • Optional compareFn: (a: number, b: number) => number
      -

      Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

      -
      [11,2,22,1].sort((a, b) => a - b)
-
      -
        • (a: number, b: number): number

        • Parameters

          • a: number
          • b: number

          Returns number

    Returns <internal>.Int8Array

subarray

  • -

    Gets a new Int8Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

    -

    Parameters

    • Optional begin: number
      -

      The index of the beginning of the array.

      -
    • Optional end: number
      -

      The index of the end of the array.

      -

    Returns <internal>.Int8Array

toLocaleString

  • toLocaleString(): string
  • -

    Converts a number to a string by using the current locale.

    -

    Returns string

toString

  • toString(): string
  • -

    Returns a string representation of an array.

    -

    Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.Int8Array

values

  • -

    Returns an list of values in the array

    -

    Returns IterableIterator<number>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Int8ArrayConstructor.html b/docs/interfaces/_internal_.Int8ArrayConstructor.html deleted file mode 100644 index a4d50e9..0000000 --- a/docs/interfaces/_internal_.Int8ArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Int8ArrayConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Int8ArrayConstructor

Hierarchy

  • Int8ArrayConstructor

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Readonly BYTES_PER_ELEMENT

BYTES_PER_ELEMENT: number
-

The size in bytes of each element in the array.

-

Readonly prototype

prototype: <internal>.Int8Array

Methods

from

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: ArrayLike<number>
      -

      An array-like or iterable object to convert to an array.

      -

    Returns <internal>.Int8Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Type parameters

    • T

    Parameters

    • arrayLike: ArrayLike<T>
      -

      An array-like or iterable object to convert to an array.

      -
    • mapfn: (v: T, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: T, k: number): number

        • Parameters

          • v: T
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Int8Array

  • -

    Creates an array from an array-like or iterable object.

    -

    Parameters

    • arrayLike: Iterable<number>
      -

      An array-like or iterable object to convert to an array.

      -
    • Optional mapfn: (v: number, k: number) => number
      -

      A mapping function to call on every element of the array.

      -
        • (v: number, k: number): number

        • Parameters

          • v: number
          • k: number

          Returns number

    • Optional thisArg: any
      -

      Value of 'this' used to invoke the mapfn.

      -

    Returns <internal>.Int8Array

of

  • -

    Returns a new array from a set of elements.

    -

    Parameters

    • Rest ...items: number[]
      -

      A set of elements to include in the new array object.

      -

    Returns <internal>.Int8Array

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.IpcSocketConnectOpts.html b/docs/interfaces/_internal_.IpcSocketConnectOpts.html deleted file mode 100644 index c424c7f..0000000 --- a/docs/interfaces/_internal_.IpcSocketConnectOpts.html +++ /dev/null @@ -1,5 +0,0 @@ -IpcSocketConnectOpts | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IpcSocketConnectOpts

Hierarchy

Index

Properties

Properties

Optional onread

onread?: OnReadOpts
-

If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. -Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will -still be emitted as normal and methods like pause() and resume() will also behave as expected.

-

path

path: string

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Iterable.html b/docs/interfaces/_internal_.Iterable.html deleted file mode 100644 index 1d7cafb..0000000 --- a/docs/interfaces/_internal_.Iterable.html +++ /dev/null @@ -1 +0,0 @@ -Iterable | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Iterable<T>

Type parameters

  • T

Hierarchy

  • Iterable

Index

Methods

Methods

[iterator]

  • [iterator](): Iterator<T, any, undefined>

  • Returns Iterator<T, any, undefined>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.IterableIterator.html b/docs/interfaces/_internal_.IterableIterator.html deleted file mode 100644 index 889f269..0000000 --- a/docs/interfaces/_internal_.IterableIterator.html +++ /dev/null @@ -1 +0,0 @@ -IterableIterator | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IterableIterator<T>

Type parameters

  • T

Hierarchy

Index

Methods

Methods

[iterator]

  • Returns IterableIterator<T>

next

  • Parameters

    • Rest ...args: [] | [undefined]

    Returns IteratorResult<T, any>

Optional return

  • Parameters

    • Optional value: any

    Returns IteratorResult<T, any>

Optional throw

  • Parameters

    • Optional e: any

    Returns IteratorResult<T, any>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Iterator.html b/docs/interfaces/_internal_.Iterator.html deleted file mode 100644 index 32f1448..0000000 --- a/docs/interfaces/_internal_.Iterator.html +++ /dev/null @@ -1 +0,0 @@ -Iterator | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Iterator<T, TReturn, TNext>

Type parameters

  • T

  • TReturn = any

  • TNext = undefined

Hierarchy

Index

Methods

Methods

next

  • Parameters

    • Rest ...args: [] | [TNext]

    Returns IteratorResult<T, TReturn>

Optional return

  • Parameters

    • Optional value: TReturn

    Returns IteratorResult<T, TReturn>

Optional throw

  • Parameters

    • Optional e: any

    Returns IteratorResult<T, TReturn>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.IteratorReturnResult.html b/docs/interfaces/_internal_.IteratorReturnResult.html deleted file mode 100644 index a9b7183..0000000 --- a/docs/interfaces/_internal_.IteratorReturnResult.html +++ /dev/null @@ -1 +0,0 @@ -IteratorReturnResult | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IteratorReturnResult<TReturn>

Type parameters

  • TReturn

Hierarchy

  • IteratorReturnResult

Index

Properties

Properties

done

done: true

value

value: TReturn

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.IteratorYieldResult.html b/docs/interfaces/_internal_.IteratorYieldResult.html deleted file mode 100644 index 820e4a8..0000000 --- a/docs/interfaces/_internal_.IteratorYieldResult.html +++ /dev/null @@ -1 +0,0 @@ -IteratorYieldResult | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface IteratorYieldResult<TYield>

Type parameters

  • TYield

Hierarchy

  • IteratorYieldResult

Index

Properties

Properties

Optional done

done?: false

value

value: TYield

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.LiveStreamData.html b/docs/interfaces/_internal_.LiveStreamData.html deleted file mode 100644 index 1ecbad6..0000000 --- a/docs/interfaces/_internal_.LiveStreamData.html +++ /dev/null @@ -1 +0,0 @@ -LiveStreamData | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LiveStreamData

Hierarchy

  • LiveStreamData

Index

Properties

Properties

dashManifestUrl

dashManifestUrl: null | string

hlsManifestUrl

hlsManifestUrl: null | string

isLive

isLive: boolean

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method
  • Property

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.LookupOneOptions.html b/docs/interfaces/_internal_.LookupOneOptions.html deleted file mode 100644 index 3042a5a..0000000 --- a/docs/interfaces/_internal_.LookupOneOptions.html +++ /dev/null @@ -1 +0,0 @@ -LookupOneOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LookupOneOptions

Hierarchy

Index

Properties

Properties

Optional all

all?: false

Optional family

family?: number

Optional hints

hints?: number

Optional verbatim

verbatim?: boolean

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.LookupOptions.html b/docs/interfaces/_internal_.LookupOptions.html deleted file mode 100644 index c2c5c9d..0000000 --- a/docs/interfaces/_internal_.LookupOptions.html +++ /dev/null @@ -1 +0,0 @@ -LookupOptions | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LookupOptions

Hierarchy

Index

Properties

Properties

Optional all

all?: boolean

Optional family

family?: number

Optional hints

hints?: number

Optional verbatim

verbatim?: boolean

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Map.html b/docs/interfaces/_internal_.Map.html deleted file mode 100644 index 00b9ebc..0000000 --- a/docs/interfaces/_internal_.Map.html +++ /dev/null @@ -1,9 +0,0 @@ -Map | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Map<K, V>

Type parameters

  • K

  • V

Hierarchy

  • Map

Index

Properties

Methods

Properties

Readonly [toStringTag]

[toStringTag]: string

Readonly size

size: number

Methods

[iterator]

  • -

    Returns an iterable of entries in the map.

    -

    Returns IterableIterator<[K, V]>

clear

  • clear(): void

  • Returns void

delete

  • delete(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

entries

  • -

    Returns an iterable of key, value pairs for every entry in the map.

    -

    Returns IterableIterator<[K, V]>

forEach

  • forEach(callbackfn: (value: V, key: K, map: <internal>.Map<K, V>) => void, thisArg?: any): void

  • Parameters

    • callbackfn: (value: V, key: K, map: <internal>.Map<K, V>) => void
    • Optional thisArg: any

    Returns void

get

  • get(key: K): undefined | V

  • Parameters

    • key: K

    Returns undefined | V

has

  • has(key: K): boolean

  • Parameters

    • key: K

    Returns boolean

keys

  • -

    Returns an iterable of keys in the map

    -

    Returns IterableIterator<K>

set

  • Parameters

    • key: K
    • value: V

    Returns <internal>.Map<K, V>

values

  • -

    Returns an iterable of values in the map

    -

    Returns IterableIterator<V>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.MapConstructor.html b/docs/interfaces/_internal_.MapConstructor.html deleted file mode 100644 index 4458074..0000000 --- a/docs/interfaces/_internal_.MapConstructor.html +++ /dev/null @@ -1 +0,0 @@ -MapConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface MapConstructor

Hierarchy

  • MapConstructor

Index

Constructors

Properties

Constructors

constructor

  • Returns <internal>.Map<any, any>

  • Type parameters

    • K

    • V

    Parameters

    • Optional entries: null | readonly readonly [K, V][]

    Returns <internal>.Map<K, V>

  • Type parameters

    • K

    • V

    Parameters

    Returns <internal>.Map<K, V>

Properties

Readonly [species]

[species]: MapConstructor

Readonly prototype

prototype: <internal>.Map<any, any>

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.NodeEventTarget.html b/docs/interfaces/_internal_.NodeEventTarget.html deleted file mode 100644 index 8e57efd..0000000 --- a/docs/interfaces/_internal_.NodeEventTarget.html +++ /dev/null @@ -1 +0,0 @@ -NodeEventTarget | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface NodeEventTarget

Hierarchy

  • NodeEventTarget

Index

Methods

Methods

once

  • once(eventName: string | symbol, listener: (...args: any[]) => void): NodeEventTarget

  • Parameters

    • eventName: string | symbol
    • listener: (...args: any[]) => void
        • (...args: any[]): void

        • Parameters

          • Rest ...args: any[]

          Returns void

    Returns NodeEventTarget

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.Object.html b/docs/interfaces/_internal_.Object.html deleted file mode 100644 index 76bd936..0000000 --- a/docs/interfaces/_internal_.Object.html +++ /dev/null @@ -1,21 +0,0 @@ -Object | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface Object

Hierarchy

  • Object

Index

Properties

Methods

Properties

constructor

constructor: <internal>.Function
-

The initial value of Object.prototype.constructor is the standard built-in Object constructor.

-

Methods

hasOwnProperty

  • -

    Determines whether an object has a property with the specified name.

    -

    Parameters

    Returns boolean

isPrototypeOf

  • -

    Determines whether an object exists in another object's prototype chain.

    -

    Parameters

    Returns boolean

propertyIsEnumerable

  • -

    Determines whether a specified property is enumerable.

    -

    Parameters

    Returns boolean

toLocaleString

  • toLocaleString(): string
  • -

    Returns a date converted to a string using the current locale.

    -

    Returns string

toString

  • toString(): string
  • -

    Returns a string representation of an object.

    -

    Returns string

valueOf

  • -

    Returns the primitive value of the specified object.

    -

    Returns <internal>.Object

Legend

  • Constructor
  • Property
  • Method
  • Private property
  • Private method

Settings

Theme

Generated using TypeDoc

\ No newline at end of file diff --git a/docs/interfaces/_internal_.ObjectConstructor.html b/docs/interfaces/_internal_.ObjectConstructor.html deleted file mode 100644 index dfce266..0000000 --- a/docs/interfaces/_internal_.ObjectConstructor.html +++ /dev/null @@ -1,157 +0,0 @@ -ObjectConstructor | play-dl
Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface ObjectConstructor

Hierarchy

  • ObjectConstructor

Callable

  • ObjectConstructor(): any
  • ObjectConstructor(value: any): any

  • Returns any

  • Parameters

    • value: any

    Returns any

Index

Constructors

Properties

Methods

Constructors

constructor

  • Parameters

    • Optional value: any

    Returns <internal>.Object

Properties

Readonly prototype

prototype: <internal>.Object
-

A reference to the prototype for a class of objects.

-

Methods

assign

  • assign<T, U>(target: T, source: U): T & U
  • assign<T, U, V>(target: T, source1: U, source2: V): T & U & V
  • assign<T, U, V, W>(target: T, source1: U, source2: V, source3: W): T & U & V & W
  • assign(target: object, ...sources: any[]): any
  • -

    Copy the values of all of the enumerable own properties from one or more source objects to a -target object. Returns the target object.

    -

    Type parameters

    • T

    • U

    Parameters

    • target: T
      -

      The target object to copy to.

      -
    • source: U
      -

      The source object from which to copy properties.

      -

    Returns T & U

  • -

    Copy the values of all of the enumerable own properties from one or more source objects to a -target object. Returns the target object.

    -

    Type parameters

    • T

    • U

    • V

    Parameters

    • target: T
      -

      The target object to copy to.

      -
    • source1: U
      -

      The first source object from which to copy properties.

      -
    • source2: V
      -

      The second source object from which to copy properties.

      -

    Returns T & U & V

  • -

    Copy the values of all of the enumerable own properties from one or more source objects to a -target object. Returns the target object.

    -

    Type parameters

    • T

    • U

    • V

    • W

    Parameters

    • target: T
      -

      The target object to copy to.

      -
    • source1: U
      -

      The first source object from which to copy properties.

      -
    • source2: V
      -

      The second source object from which to copy properties.

      -
    • source3: W
      -

      The third source object from which to copy properties.

      -

    Returns T & U & V & W

  • -

    Copy the values of all of the enumerable own properties from one or more source objects to a -target object. Returns the target object.

    -

    Parameters

    • target: object
      -

      The target object to copy to.

      -
    • Rest ...sources: any[]
      -

      One or more source objects from which to copy properties

      -

    Returns any

create

  • -

    Creates an object that has the specified prototype or that has null prototype.

    -

    Parameters

    • o: null | object
      -

      Object to use as a prototype. May be null.

      -

    Returns any

  • -

    Creates an object that has the specified prototype, and that optionally contains specified properties.

    -

    Parameters

    • o: null | object
      -

      Object to use as a prototype. May be null

      -
    • properties: PropertyDescriptorMap & ThisType<any>
      -

      JavaScript object that contains one or more property descriptors.

      -

    Returns any

defineProperties

  • -

    Adds one or more properties to an object, and/or modifies attributes of existing properties.

    -

    Type parameters

    • T

    Parameters

    • o: T
      -

      Object on which to add or modify the properties. This can be a native JavaScript object or a DOM object.

      -
    • properties: PropertyDescriptorMap & ThisType<any>
      -

      JavaScript object that contains one or more descriptor objects. Each descriptor object describes a data property or an accessor property.

      -

    Returns T

defineProperty

  • -

    Adds a property to an object, or modifies attributes of an existing property.

    -

    Type parameters

    • T

    Parameters

    • o: T
      -

      Object on which to add or modify the property. This can be a native JavaScript object (that is, a user-defined object or a built in object) or a DOM object.

      -
    • p: PropertyKey
      -

      The property name.

      -
    • attributes: PropertyDescriptor & ThisType<any>
      -

      Descriptor for the property. It can be for a data property or an accessor property.

      -

    Returns T

entries

  • entries<T>(o: {} | ArrayLike<T>): [string, T][]
  • entries(o: {}): [string, any][]
  • -

    Returns an array of key/values of the enumerable properties of an object

    -

    Type parameters

    • T

    Parameters

    • o: {} | ArrayLike<T>
      -

      Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      -

    Returns [string, T][]

  • -

    Returns an array of key/values of the enumerable properties of an object

    -

    Parameters

    • o: {}
      -

      Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

      -

      Returns [string, any][]

    freeze

    • freeze<T>(a: T[]): readonly T[]
    • freeze<T>(f: T): T
    • freeze<T>(o: T): Readonly<T>
    • -

      Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

      -

      Type parameters

      • T

      Parameters

      • a: T[]

      Returns readonly T[]

    • -

      Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

      -

      Type parameters

      Parameters

      • f: T

      Returns T

    • -

      Prevents the modification of existing property attributes and values, and prevents the addition of new properties.

      -

      Type parameters

      • T

      Parameters

      • o: T
        -

        Object on which to lock the attributes.

        -

      Returns Readonly<T>

    fromEntries

    • -

      Returns an object created by key-value entries for properties and methods

      -

      Type parameters

      • T = any

      Parameters

      • entries: Iterable<readonly [PropertyKey, T]>
        -

        An iterable object that contains key-value entries for properties and methods.

        -

      Returns {}

      • [k: string]: T
    • -

      Returns an object created by key-value entries for properties and methods

      -

      Parameters

      • entries: Iterable<readonly any[]>
        -

        An iterable object that contains key-value entries for properties and methods.

        -

      Returns any

    getOwnPropertyDescriptor

    • -

      Gets the own property descriptor of the specified object. -An own property descriptor is one that is defined directly on the object and is not inherited from the object's prototype.

      -

      Parameters

      • o: any
        -

        Object that contains the property.

        -
      • p: PropertyKey
        -

        Name of the property.

        -

      Returns undefined | PropertyDescriptor

    getOwnPropertyDescriptors

    • -

      Returns an object containing all own property descriptors of an object

      -

      Type parameters

      • T

      Parameters

      • o: T
        -

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

        -

      Returns { [ P in string | number | symbol]: TypedPropertyDescriptor<T[P]> } & {}

    getOwnPropertyNames

    • getOwnPropertyNames(o: any): string[]
    • -

      Returns the names of the own properties of an object. The own properties of an object are those that are defined directly -on that object, and are not inherited from the object's prototype. The properties of an object include both fields (objects) and functions.

      -

      Parameters

      • o: any
        -

        Object that contains the own properties.

        -

      Returns string[]

    getOwnPropertySymbols

    • getOwnPropertySymbols(o: any): symbol[]
    • -

      Returns an array of all symbol properties found directly on object o.

      -

      Parameters

      • o: any
        -

        Object to retrieve the symbols from.

        -

      Returns symbol[]

    getPrototypeOf

    • getPrototypeOf(o: any): any
    • -

      Returns the prototype of an object.

      -

      Parameters

      • o: any
        -

        The object that references the prototype.

        -

      Returns any

    is

    • is(value1: any, value2: any): boolean
    • -

      Returns true if the values are the same value, false otherwise.

      -

      Parameters

      • value1: any
        -

        The first value.

        -
      • value2: any
        -

        The second value.

        -

      Returns boolean

    isExtensible

    • isExtensible(o: any): boolean
    • -

      Returns a value that indicates whether new properties can be added to an object.

      -

      Parameters

      • o: any
        -

        Object to test.

        -

      Returns boolean

    isFrozen

    • isFrozen(o: any): boolean
    • -

      Returns true if existing property attributes and values cannot be modified in an object, and new properties cannot be added to the object.

      -

      Parameters

      • o: any
        -

        Object to test.

        -

      Returns boolean

    isSealed

    • isSealed(o: any): boolean
    • -

      Returns true if existing property attributes cannot be modified in an object and new properties cannot be added to the object.

      -

      Parameters

      • o: any
        -

        Object to test.

        -

      Returns boolean

    keys

    • keys(o: object): string[]
    • keys(o: {}): string[]
    • -

      Returns the names of the enumerable string properties and methods of an object.

      -

      Parameters

      • o: object
        -

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

        -

      Returns string[]

    • -

      Returns the names of the enumerable string properties and methods of an object.

      -

      Parameters

      • o: {}
        -

        Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

        -

        Returns string[]

      preventExtensions

      • preventExtensions<T>(o: T): T
      • -

        Prevents the addition of new properties to an object.

        -

        Type parameters

        • T

        Parameters

        • o: T
          -

          Object to make non-extensible.

          -

        Returns T

      seal

      • seal<T>(o: T): T
      • -

        Prevents the modification of attributes of existing properties, and prevents the addition of new properties.

        -

        Type parameters

        • T

        Parameters

        • o: T
          -

          Object on which to lock the attributes.

          -

        Returns T

      setPrototypeOf

      • setPrototypeOf(o: any, proto: null | object): any
      • -

        Sets the prototype of a specified object o to object proto or null. Returns the object o.

        -

        Parameters

        • o: any
          -

          The object to change its prototype.

          -
        • proto: null | object
          -

          The value of the new prototype or null.

          -

        Returns any

      values

      • values<T>(o: {} | ArrayLike<T>): T[]
      • values(o: {}): any[]
      • -

        Returns an array of values of the enumerable properties of an object

        -

        Type parameters

        • T

        Parameters

        • o: {} | ArrayLike<T>
          -

          Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

          -

        Returns T[]

      • -

        Returns an array of values of the enumerable properties of an object

        -

        Parameters

        • o: {}
          -

          Object that contains the properties and methods. This can be an object that you created or an existing Document Object Model (DOM) object.

          -

          Returns any[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.OnReadOpts.html b/docs/interfaces/_internal_.OnReadOpts.html deleted file mode 100644 index 11bde86..0000000 --- a/docs/interfaces/_internal_.OnReadOpts.html +++ /dev/null @@ -1,5 +0,0 @@ -OnReadOpts | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface OnReadOpts

        Hierarchy

        • OnReadOpts

        Index

        Properties

        Methods

        Properties

        buffer

        buffer: <internal>.Uint8Array | (() => <internal>.Uint8Array)

        Methods

        callback

        • -

          This function is called for every chunk of incoming data. -Two arguments are passed to it: the number of bytes written to buffer and a reference to buffer. -Return false from this function to implicitly pause() the socket.

          -

          Parameters

          Returns boolean

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PlaylistJSON-1.html b/docs/interfaces/_internal_.PlaylistJSON-1.html deleted file mode 100644 index 77f34e6..0000000 --- a/docs/interfaces/_internal_.PlaylistJSON-1.html +++ /dev/null @@ -1,17 +0,0 @@ -PlaylistJSON | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PlaylistJSON

        Hierarchy

        • PlaylistJSON

        Index

        Properties

        Properties

        collaborative

        collaborative: boolean
        -

        Spotify Playlist collaborative boolean.

        -

        description

        description: string
        -

        Spotify Playlist Description

        -

        id

        id: string
        -

        Spotify Playlist ID

        -

        name

        name: string
        -

        Spotify Playlist Name

        -

        owner

        owner: SpotifyArtists
        -

        Spotify Playlist Owner Artist data

        -

        thumbnail

        thumbnail: SpotifyThumbnail
        -

        Spotify Playlist Thumbnail Data

        -

        tracksCount

        tracksCount: number
        -

        Spotify Playlist total tracks Count

        -

        url

        url: string
        -

        Spotify Playlist URL

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PlaylistJSON.html b/docs/interfaces/_internal_.PlaylistJSON.html deleted file mode 100644 index 8b0da96..0000000 --- a/docs/interfaces/_internal_.PlaylistJSON.html +++ /dev/null @@ -1,21 +0,0 @@ -PlaylistJSON | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PlaylistJSON

        Hierarchy

        • PlaylistJSON

        Index

        Properties

        Properties

        Optional channel

        channel?: YouTubeChannel
        -

        YouTube Playlist channel data

        -

        Optional id

        id?: string
        -

        YouTube Playlist ID

        -

        Optional lastUpdate

        lastUpdate?: string
        -

        Time when playlist was last updated

        -

        Optional link

        link?: string
        -

        YouTube Playlist url with starting video url.

        -

        Optional thumbnail

        thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }
        -

        YouTube Playlist thumbnail Data

        -

        Type declaration

        • height: undefined | number
        • id: undefined | string
        • url: undefined | string
        • width: undefined | number

        Optional title

        title?: string
        -

        YouTube Playlist Name

        -

        Optional url

        url?: string
        -

        YouTube Playlist url

        -

        Optional videoCount

        videoCount?: number
        -

        Total no of videos in that playlist

        -

        Optional videos

        videos?: YouTubeVideo[]
        -

        first 100 videos in that playlist

        -

        Optional views

        views?: number
        -

        Total views of that playlist

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PlaylistOptions.html b/docs/interfaces/_internal_.PlaylistOptions.html deleted file mode 100644 index b738ad2..0000000 --- a/docs/interfaces/_internal_.PlaylistOptions.html +++ /dev/null @@ -1 +0,0 @@ -PlaylistOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PlaylistOptions

        Hierarchy

        • PlaylistOptions

        Index

        Properties

        Properties

        Optional incomplete

        incomplete?: boolean

        Optional proxy

        proxy?: ProxyOptions[]

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Promise.html b/docs/interfaces/_internal_.Promise.html deleted file mode 100644 index b032ea2..0000000 --- a/docs/interfaces/_internal_.Promise.html +++ /dev/null @@ -1,21 +0,0 @@ -Promise | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Promise<T>

        -

        Represents the completion of an asynchronous operation

        -

        Type parameters

        • T

        Hierarchy

        • Promise

        Index

        Properties

        Methods

        Properties

        Readonly [toStringTag]

        [toStringTag]: string

        Methods

        catch

        • -

          Attaches a callback for only the rejection of the Promise.

          -

          Type parameters

          • TResult = never

          Parameters

          • Optional onrejected: null | ((reason: any) => TResult | PromiseLike<TResult>)
            -

            The callback to execute when the Promise is rejected.

            -

          Returns <internal>.Promise<T | TResult>

          A Promise for the completion of the callback.

          -

        finally

        • -

          Attaches a callback that is invoked when the Promise is settled (fulfilled or rejected). The -resolved value cannot be modified from the callback.

          -

          Parameters

          • Optional onfinally: null | (() => void)
            -

            The callback to execute when the Promise is settled (fulfilled or rejected).

            -

          Returns <internal>.Promise<T>

          A Promise for the completion of the callback.

          -

        then

        • then<TResult1, TResult2>(onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): <internal>.Promise<TResult1 | TResult2>
        • -

          Attaches callbacks for the resolution and/or rejection of the Promise.

          -

          Type parameters

          • TResult1 = T

          • TResult2 = never

          Parameters

          • Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
            -

            The callback to execute when the Promise is resolved.

            -
          • Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
            -

            The callback to execute when the Promise is rejected.

            -

          Returns <internal>.Promise<TResult1 | TResult2>

          A Promise for the completion of which ever callback is executed.

          -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PromiseConstructor.html b/docs/interfaces/_internal_.PromiseConstructor.html deleted file mode 100644 index 596589a..0000000 --- a/docs/interfaces/_internal_.PromiseConstructor.html +++ /dev/null @@ -1,123 +0,0 @@ -PromiseConstructor | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PromiseConstructor

        Hierarchy

        • PromiseConstructor

        Index

        Constructors

        Properties

        Methods

        Constructors

        constructor

        • new PromiseConstructor<T>(executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void): <internal>.Promise<T>
        • -

          Creates a new Promise.

          -

          Type parameters

          • T

          Parameters

          • executor: (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void) => void
            -

            A callback used to initialize the promise. This callback is passed two arguments: -a resolve callback used to resolve the promise with a value or the result of another promise, -and a reject callback used to reject the promise with a provided reason or error.

            -
              • (resolve: (value: T | PromiseLike<T>) => void, reject: (reason?: any) => void): void

              • Parameters

                • resolve: (value: T | PromiseLike<T>) => void
                • reject: (reason?: any) => void
                    • (reason?: any): void

                    • Parameters

                      • Optional reason: any

                      Returns void

                Returns void

          Returns <internal>.Promise<T>

        Properties

        Readonly [species]

        [species]: PromiseConstructor

        Readonly prototype

        prototype: <internal>.Promise<any>
        -

        A reference to the prototype.

        -

        Methods

        all

        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T

          Parameters

          Returns <internal>.Promise<T[]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          • T3

          • T4

          • T5

          • T6

          • T7

          • T8

          • T9

          • T10

          Parameters

          Returns <internal>.Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9, T10]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          • T3

          • T4

          • T5

          • T6

          • T7

          • T8

          • T9

          Parameters

          Returns <internal>.Promise<[T1, T2, T3, T4, T5, T6, T7, T8, T9]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          • T3

          • T4

          • T5

          • T6

          • T7

          • T8

          Parameters

          Returns <internal>.Promise<[T1, T2, T3, T4, T5, T6, T7, T8]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          • T3

          • T4

          • T5

          • T6

          • T7

          Parameters

          Returns <internal>.Promise<[T1, T2, T3, T4, T5, T6, T7]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          • T3

          • T4

          • T5

          • T6

          Parameters

          Returns <internal>.Promise<[T1, T2, T3, T4, T5, T6]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          • T3

          • T4

          • T5

          Parameters

          Returns <internal>.Promise<[T1, T2, T3, T4, T5]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          • T3

          • T4

          Parameters

          Returns <internal>.Promise<[T1, T2, T3, T4]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          • T3

          Parameters

          Returns <internal>.Promise<[T1, T2, T3]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T1

          • T2

          Parameters

          Returns <internal>.Promise<[T1, T2]>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all of the provided Promises -resolve, or rejected when any Promise is rejected.

          -

          Type parameters

          • T

          Parameters

          • values: readonly (T | PromiseLike<T>)[]
            -

            An array of Promises.

            -

          Returns <internal>.Promise<T[]>

          A new Promise.

          -

        allSettled

        • -

          Creates a Promise that is resolved with an array of results when all -of the provided Promises resolve or reject.

          -

          Type parameters

          • T: readonly unknown[] | readonly [unknown]

          Parameters

          • values: T
            -

            An array of Promises.

            -

          Returns <internal>.Promise<{ -readonly [ P in string | number | symbol]: PromiseSettledResult<T[P] extends PromiseLike<U> ? U : T[P]> }>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved with an array of results when all -of the provided Promises resolve or reject.

          -

          Type parameters

          • T

          Parameters

          • values: Iterable<T>
            -

            An array of Promises.

            -

          Returns <internal>.Promise<PromiseSettledResult<T extends PromiseLike<U> ? U : T>[]>

          A new Promise.

          -

        any

        • -

          The any function returns a promise that is fulfilled by the first given promise to be fulfilled, or rejected with an AggregateError containing an array of rejection reasons if all of the given promises are rejected. It resolves all elements of the passed iterable to promises as it runs this algorithm.

          -

          Type parameters

          • T

          Parameters

          Returns <internal>.Promise<T>

          A new Promise.

          -

        race

        • -

          Creates a Promise that is resolved or rejected when any of the provided Promises are resolved -or rejected.

          -

          Type parameters

          • T

          Parameters

          • values: Iterable<T>
            -

            An iterable of Promises.

            -

          Returns <internal>.Promise<T extends PromiseLike<U> ? U : T>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved or rejected when any of the provided Promises are resolved -or rejected.

          -

          Type parameters

          • T

          Parameters

          Returns <internal>.Promise<T>

          A new Promise.

          -
        • -

          Creates a Promise that is resolved or rejected when any of the provided Promises are resolved -or rejected.

          -

          Type parameters

          • T

          Parameters

          • values: readonly T[]
            -

            An array of Promises.

            -

          Returns <internal>.Promise<T extends PromiseLike<U> ? U : T>

          A new Promise.

          -

        reject

        • -

          Creates a new rejected promise for the provided reason.

          -

          Type parameters

          • T = never

          Parameters

          • Optional reason: any
            -

            The reason the promise was rejected.

            -

          Returns <internal>.Promise<T>

          A new rejected Promise.

          -

        resolve

        • -

          Creates a new resolved promise.

          -

          Returns <internal>.Promise<void>

          A resolved promise.

          -
        • -

          Creates a new resolved promise for the provided value.

          -

          Type parameters

          • T

          Parameters

          Returns <internal>.Promise<T>

          A promise whose internal state matches the provided promise.

          -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PromiseFulfilledResult.html b/docs/interfaces/_internal_.PromiseFulfilledResult.html deleted file mode 100644 index 2867dbe..0000000 --- a/docs/interfaces/_internal_.PromiseFulfilledResult.html +++ /dev/null @@ -1 +0,0 @@ -PromiseFulfilledResult | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PromiseFulfilledResult<T>

        Type parameters

        • T

        Hierarchy

        • PromiseFulfilledResult

        Index

        Properties

        Properties

        status

        status: "fulfilled"

        value

        value: T

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PromiseLike.html b/docs/interfaces/_internal_.PromiseLike.html deleted file mode 100644 index dbff332..0000000 --- a/docs/interfaces/_internal_.PromiseLike.html +++ /dev/null @@ -1,8 +0,0 @@ -PromiseLike | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PromiseLike<T>

        Type parameters

        • T

        Hierarchy

        • PromiseLike

        Index

        Methods

        Methods

        then

        • then<TResult1, TResult2>(onfulfilled?: null | ((value: T) => TResult1 | PromiseLike<TResult1>), onrejected?: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)): PromiseLike<TResult1 | TResult2>
        • -

          Attaches callbacks for the resolution and/or rejection of the Promise.

          -

          Type parameters

          • TResult1 = T

          • TResult2 = never

          Parameters

          • Optional onfulfilled: null | ((value: T) => TResult1 | PromiseLike<TResult1>)
            -

            The callback to execute when the Promise is resolved.

            -
          • Optional onrejected: null | ((reason: any) => TResult2 | PromiseLike<TResult2>)
            -

            The callback to execute when the Promise is rejected.

            -

          Returns PromiseLike<TResult1 | TResult2>

          A Promise for the completion of which ever callback is executed.

          -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PromiseRejectedResult.html b/docs/interfaces/_internal_.PromiseRejectedResult.html deleted file mode 100644 index fae3678..0000000 --- a/docs/interfaces/_internal_.PromiseRejectedResult.html +++ /dev/null @@ -1 +0,0 @@ -PromiseRejectedResult | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PromiseRejectedResult

        Hierarchy

        • PromiseRejectedResult

        Index

        Properties

        Properties

        reason

        reason: any

        status

        status: "rejected"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PropertyDescriptor.html b/docs/interfaces/_internal_.PropertyDescriptor.html deleted file mode 100644 index 1899fe0..0000000 --- a/docs/interfaces/_internal_.PropertyDescriptor.html +++ /dev/null @@ -1 +0,0 @@ -PropertyDescriptor | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PropertyDescriptor

        Hierarchy

        • PropertyDescriptor

        Index

        Properties

        Methods

        Properties

        Optional configurable

        configurable?: boolean

        Optional enumerable

        enumerable?: boolean

        Optional value

        value?: any

        Optional writable

        writable?: boolean

        Methods

        Optional get

        • get(): any

        • Returns any

        Optional set

        • set(v: any): void

        • Parameters

          • v: any

          Returns void

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.PropertyDescriptorMap.html b/docs/interfaces/_internal_.PropertyDescriptorMap.html deleted file mode 100644 index 7567e1f..0000000 --- a/docs/interfaces/_internal_.PropertyDescriptorMap.html +++ /dev/null @@ -1 +0,0 @@ -PropertyDescriptorMap | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PropertyDescriptorMap

        Hierarchy

        • PropertyDescriptorMap

        Indexable

        [s: string]: PropertyDescriptor

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.ProxyOpts.html b/docs/interfaces/_internal_.ProxyOpts.html deleted file mode 100644 index 1809d66..0000000 --- a/docs/interfaces/_internal_.ProxyOpts.html +++ /dev/null @@ -1 +0,0 @@ -ProxyOpts | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ProxyOpts

        Hierarchy

        • ProxyOpts

        Index

        Properties

        Properties

        Optional authentication

        authentication?: { password: string; username: string }

        Type declaration

        • password: string
        • username: string

        host

        host: string

        port

        port: number

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.ReadWriteStream.html b/docs/interfaces/_internal_.ReadWriteStream.html deleted file mode 100644 index 843d2c2..0000000 --- a/docs/interfaces/_internal_.ReadWriteStream.html +++ /dev/null @@ -1,135 +0,0 @@ -ReadWriteStream | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ReadWriteStream

        Hierarchy

        Index

        Properties

        Methods

        Properties

        readable

        readable: boolean

        writable

        writable: boolean

        Methods

        [asyncIterator]

        addListener

        • addListener(eventName: string | symbol, listener: (...args: any[]) => void): ReadWriteStream
        • -

          Alias for emitter.on(eventName, listener).

          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadWriteStream

        emit

        • emit(eventName: string | symbol, ...args: any[]): boolean
        • -

          Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

          -

          Returns true if the event had listeners, false otherwise.

          -
          const EventEmitter = require('events');
          const myEmitter = new EventEmitter();

          // First listener
          myEmitter.on('event', function firstListener() {
            console.log('Helloooo! first listener');
          });
          // Second listener
          myEmitter.on('event', function secondListener(arg1, arg2) {
            console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
          });
          // Third listener
          myEmitter.on('event', function thirdListener(...args) {
            const parameters = args.join(', ');
            console.log(`event with parameters ${parameters} in third listener`);
          });

          console.log(myEmitter.listeners('event'));

          myEmitter.emit('event', 1, 2, 3, 4, 5);

          // Prints:
          // [
          //   [Function: firstListener],
          //   [Function: secondListener],
          //   [Function: thirdListener]
          // ]
          // Helloooo! first listener
          // event with parameters 1, 2 in second listener
          // event with parameters 1, 2, 3, 4, 5 in third listener
-
          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • Rest ...args: any[]

          Returns boolean

        end

        • Parameters

          • Optional cb: () => void
              • (): void

              • Returns void

          Returns void

        • Parameters

          Returns void

        • Parameters

          • str: string
          • Optional encoding: BufferEncoding
          • Optional cb: () => void
              • (): void

              • Returns void

          Returns void

        eventNames

        • eventNames(): (string | symbol)[]
        • -

          Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

          -
          const EventEmitter = require('events');
          const myEE = new EventEmitter();
          myEE.on('foo', () => {});
          myEE.on('bar', () => {});

          const sym = Symbol('symbol');
          myEE.on(sym, () => {});

          console.log(myEE.eventNames());
          // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
          -
          since

          v6.0.0

          -

          Returns (string | symbol)[]

        getMaxListeners

        • getMaxListeners(): number
        • -

          Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

          -
          since

          v1.0.0

          -

          Returns number

        isPaused

        • isPaused(): boolean

        listenerCount

        • listenerCount(eventName: string | symbol): number
        • -

          Returns the number of listeners listening to the event named eventName.

          -
          since

          v3.2.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event being listened for

            -

          Returns number

        listeners

        • -

          Returns a copy of the array of listeners for the event named eventName.

          -
          server.on('connection', (stream) => {
            console.log('someone connected!');
          });
          console.log(util.inspect(server.listeners('connection')));
          // Prints: [ [Function] ]
-
          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol

          Returns <internal>.Function[]

        off

        • off(eventName: string | symbol, listener: (...args: any[]) => void): ReadWriteStream
        • -

          Alias for emitter.removeListener().

          -
          since

          v10.0.0

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadWriteStream

        on

        • on(eventName: string | symbol, listener: (...args: any[]) => void): ReadWriteStream
        • -

          Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

          -
          server.on('connection', (stream) => {
            console.log('someone connected!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -

          By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

          -
          const myEE = new EventEmitter();
          myEE.on('foo', () => console.log('a'));
          myEE.prependListener('foo', () => console.log('b'));
          myEE.emit('foo');
          // Prints:
          //   b
          //   a
-
          -
          since

          v0.1.101

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadWriteStream

        once

        • once(eventName: string | symbol, listener: (...args: any[]) => void): ReadWriteStream
        • -

          Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

          -
          server.once('connection', (stream) => {
            console.log('Ah, we have our first user!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -

          By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

          -
          const myEE = new EventEmitter();
          myEE.once('foo', () => console.log('a'));
          myEE.prependOnceListener('foo', () => console.log('b'));
          myEE.emit('foo');
          // Prints:
          //   b
          //   a
-
          -
          since

          v0.3.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadWriteStream

        pause

        pipe

        • pipe<T>(destination: T, options?: { end?: boolean }): T

        • Type parameters

          Parameters

          • destination: T
          • Optional options: { end?: boolean }
            • Optional end?: boolean

          Returns T

        prependListener

        • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): ReadWriteStream
        • -

          Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

          -
          server.prependListener('connection', (stream) => {
            console.log('someone connected!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v6.0.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadWriteStream

        prependOnceListener

        • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): ReadWriteStream
        • -

          Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

          -
          server.prependOnceListener('connection', (stream) => {
            console.log('Ah, we have our first user!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v6.0.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadWriteStream

        rawListeners

        • -

          Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

          -
          const emitter = new EventEmitter();
          emitter.once('log', () => console.log('log once'));

          // Returns a new Array with a function `onceWrapper` which has a property
          // `listener` which contains the original listener bound above
          const listeners = emitter.rawListeners('log');
          const logFnWrapper = listeners[0];

          // Logs "log once" to the console and does not unbind the `once` event
          logFnWrapper.listener();

          // Logs "log once" to the console and removes the listener
          logFnWrapper();

          emitter.on('log', () => console.log('log persistently'));
          // Will return a new Array with a single function bound by `.on()` above
          const newListeners = emitter.rawListeners('log');

          // Logs "log persistently" twice
          newListeners[0]();
          emitter.emit('log');
-
          -
          since

          v9.4.0

          -

          Parameters

          • eventName: string | symbol

          Returns <internal>.Function[]

        read

        removeAllListeners

        • -

          Removes all listeners, or those of the specified eventName.

          -

          It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.1.26

          -

          Parameters

          • Optional event: string | symbol

          Returns ReadWriteStream

        removeListener

        • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): ReadWriteStream
        • -

          Removes the specified listener from the listener array for the event namedeventName.

          -
          const callback = (stream) => {
            console.log('someone connected!');
          };
          server.on('connection', callback);
          // ...
          server.removeListener('connection', callback);
-
          -

          removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

          -

          Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

          -
          const myEmitter = new MyEmitter();

          const callbackA = () => {
            console.log('A');
            myEmitter.removeListener('event', callbackB);
          };

          const callbackB = () => {
            console.log('B');
          };

          myEmitter.on('event', callbackA);

          myEmitter.on('event', callbackB);

          // callbackA removes listener callbackB but it will still be called.
          // Internal listener array at time of emit [callbackA, callbackB]
          myEmitter.emit('event');
          // Prints:
          //   A
          //   B

          // callbackB is now removed.
          // Internal listener array [callbackA]
          myEmitter.emit('event');
          // Prints:
          //   A
-
          -

          Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

          -

          When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

          -
          const ee = new EventEmitter();

          function pong() {
            console.log('pong');
          }

          ee.on('ping', pong);
          ee.once('ping', pong);
          ee.removeListener('ping', pong);

          ee.emit('ping');
          ee.emit('ping');
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadWriteStream

        resume

        setEncoding

        setMaxListeners

        • -

          By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.3.5

          -

          Parameters

          • n: number

          Returns ReadWriteStream

        unpipe

        unshift

        wrap

        write

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.ReadableOptions.html b/docs/interfaces/_internal_.ReadableOptions.html deleted file mode 100644 index afe6a27..0000000 --- a/docs/interfaces/_internal_.ReadableOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -ReadableOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ReadableOptions

        Hierarchy

        Index

        Properties

        Methods

        Properties

        Optional autoDestroy

        autoDestroy?: boolean

        Optional emitClose

        emitClose?: boolean

        Optional encoding

        encoding?: BufferEncoding

        Optional highWaterMark

        highWaterMark?: number

        Optional objectMode

        objectMode?: boolean

        Optional signal

        signal?: <internal>.AbortSignal
        -

        When provided the corresponding AbortController can be used to cancel an asynchronous action.

        -

        Methods

        Optional construct

        Optional destroy

        Optional read

        • read(size: number): void

        • Parameters

          • size: number

          Returns void

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.ReadableStream.html b/docs/interfaces/_internal_.ReadableStream.html deleted file mode 100644 index 7d9f681..0000000 --- a/docs/interfaces/_internal_.ReadableStream.html +++ /dev/null @@ -1,135 +0,0 @@ -ReadableStream | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ReadableStream

        Hierarchy

        Implemented by

        Index

        Properties

        Methods

        Properties

        readable

        readable: boolean

        Methods

        [asyncIterator]

        addListener

        • addListener(eventName: string | symbol, listener: (...args: any[]) => void): ReadableStream
        • -

          Alias for emitter.on(eventName, listener).

          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadableStream

        emit

        • emit(eventName: string | symbol, ...args: any[]): boolean
        • -

          Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

          -

          Returns true if the event had listeners, false otherwise.

          -
          const EventEmitter = require('events');
          const myEmitter = new EventEmitter();

          // First listener
          myEmitter.on('event', function firstListener() {
            console.log('Helloooo! first listener');
          });
          // Second listener
          myEmitter.on('event', function secondListener(arg1, arg2) {
            console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
          });
          // Third listener
          myEmitter.on('event', function thirdListener(...args) {
            const parameters = args.join(', ');
            console.log(`event with parameters ${parameters} in third listener`);
          });

          console.log(myEmitter.listeners('event'));

          myEmitter.emit('event', 1, 2, 3, 4, 5);

          // Prints:
          // [
          //   [Function: firstListener],
          //   [Function: secondListener],
          //   [Function: thirdListener]
          // ]
          // Helloooo! first listener
          // event with parameters 1, 2 in second listener
          // event with parameters 1, 2, 3, 4, 5 in third listener
-
          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • Rest ...args: any[]

          Returns boolean

        eventNames

        • eventNames(): (string | symbol)[]
        • -

          Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

          -
          const EventEmitter = require('events');
          const myEE = new EventEmitter();
          myEE.on('foo', () => {});
          myEE.on('bar', () => {});

          const sym = Symbol('symbol');
          myEE.on(sym, () => {});

          console.log(myEE.eventNames());
          // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
          -
          since

          v6.0.0

          -

          Returns (string | symbol)[]

        getMaxListeners

        • getMaxListeners(): number
        • -

          Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

          -
          since

          v1.0.0

          -

          Returns number

        isPaused

        • isPaused(): boolean

        • Returns boolean

        listenerCount

        • listenerCount(eventName: string | symbol): number
        • -

          Returns the number of listeners listening to the event named eventName.

          -
          since

          v3.2.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event being listened for

            -

          Returns number

        listeners

        • -

          Returns a copy of the array of listeners for the event named eventName.

          -
          server.on('connection', (stream) => {
            console.log('someone connected!');
          });
          console.log(util.inspect(server.listeners('connection')));
          // Prints: [ [Function] ]
-
          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol

          Returns <internal>.Function[]

        off

        • off(eventName: string | symbol, listener: (...args: any[]) => void): ReadableStream
        • -

          Alias for emitter.removeListener().

          -
          since

          v10.0.0

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadableStream

        on

        • on(eventName: string | symbol, listener: (...args: any[]) => void): ReadableStream
        • -

          Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

          -
          server.on('connection', (stream) => {
            console.log('someone connected!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -

          By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

          -
          const myEE = new EventEmitter();
          myEE.on('foo', () => console.log('a'));
          myEE.prependListener('foo', () => console.log('b'));
          myEE.emit('foo');
          // Prints:
          //   b
          //   a
-
          -
          since

          v0.1.101

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadableStream

        once

        • once(eventName: string | symbol, listener: (...args: any[]) => void): ReadableStream
        • -

          Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

          -
          server.once('connection', (stream) => {
            console.log('Ah, we have our first user!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -

          By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

          -
          const myEE = new EventEmitter();
          myEE.once('foo', () => console.log('a'));
          myEE.prependOnceListener('foo', () => console.log('b'));
          myEE.emit('foo');
          // Prints:
          //   b
          //   a
-
          -
          since

          v0.3.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadableStream

        pause

        • Returns ReadableStream

        pipe

        • pipe<T>(destination: T, options?: { end?: boolean }): T

        • Type parameters

          Parameters

          • destination: T
          • Optional options: { end?: boolean }
            • Optional end?: boolean

          Returns T

        prependListener

        • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): ReadableStream
        • -

          Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

          -
          server.prependListener('connection', (stream) => {
            console.log('someone connected!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v6.0.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadableStream

        prependOnceListener

        • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): ReadableStream
        • -

          Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

          -
          server.prependOnceListener('connection', (stream) => {
            console.log('Ah, we have our first user!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v6.0.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadableStream

        rawListeners

        • -

          Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

          -
          const emitter = new EventEmitter();
          emitter.once('log', () => console.log('log once'));

          // Returns a new Array with a function `onceWrapper` which has a property
          // `listener` which contains the original listener bound above
          const listeners = emitter.rawListeners('log');
          const logFnWrapper = listeners[0];

          // Logs "log once" to the console and does not unbind the `once` event
          logFnWrapper.listener();

          // Logs "log once" to the console and removes the listener
          logFnWrapper();

          emitter.on('log', () => console.log('log persistently'));
          // Will return a new Array with a single function bound by `.on()` above
          const newListeners = emitter.rawListeners('log');

          // Logs "log persistently" twice
          newListeners[0]();
          emitter.emit('log');
-
          -
          since

          v9.4.0

          -

          Parameters

          • eventName: string | symbol

          Returns <internal>.Function[]

        read

        • Parameters

          • Optional size: number

          Returns string | <internal>.Buffer

        removeAllListeners

        • -

          Removes all listeners, or those of the specified eventName.

          -

          It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.1.26

          -

          Parameters

          • Optional event: string | symbol

          Returns ReadableStream

        removeListener

        • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): ReadableStream
        • -

          Removes the specified listener from the listener array for the event namedeventName.

          -
          const callback = (stream) => {
            console.log('someone connected!');
          };
          server.on('connection', callback);
          // ...
          server.removeListener('connection', callback);
-
          -

          removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

          -

          Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

          -
          const myEmitter = new MyEmitter();

          const callbackA = () => {
            console.log('A');
            myEmitter.removeListener('event', callbackB);
          };

          const callbackB = () => {
            console.log('B');
          };

          myEmitter.on('event', callbackA);

          myEmitter.on('event', callbackB);

          // callbackA removes listener callbackB but it will still be called.
          // Internal listener array at time of emit [callbackA, callbackB]
          myEmitter.emit('event');
          // Prints:
          //   A
          //   B

          // callbackB is now removed.
          // Internal listener array [callbackA]
          myEmitter.emit('event');
          // Prints:
          //   A
-
          -

          Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

          -

          When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

          -
          const ee = new EventEmitter();

          function pong() {
            console.log('pong');
          }

          ee.on('ping', pong);
          ee.once('ping', pong);
          ee.removeListener('ping', pong);

          ee.emit('ping');
          ee.emit('ping');
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns ReadableStream

        resume

        • Returns ReadableStream

        setEncoding

        setMaxListeners

        • -

          By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.3.5

          -

          Parameters

          • n: number

          Returns ReadableStream

        unpipe

        unshift

        wrap

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.RefCounted.html b/docs/interfaces/_internal_.RefCounted.html deleted file mode 100644 index 94fb27a..0000000 --- a/docs/interfaces/_internal_.RefCounted.html +++ /dev/null @@ -1 +0,0 @@ -RefCounted | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface RefCounted

        Hierarchy

        Index

        Methods

        Methods

        ref

        • Returns RefCounted

        unref

        • Returns RefCounted

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.RelativeIndexable.html b/docs/interfaces/_internal_.RelativeIndexable.html deleted file mode 100644 index 580bacd..0000000 --- a/docs/interfaces/_internal_.RelativeIndexable.html +++ /dev/null @@ -1,5 +0,0 @@ -RelativeIndexable | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface RelativeIndexable<T>

        Type parameters

        • T

        Hierarchy

        Index

        Methods

        Methods

        at

        • at(index: number): undefined | T
        • -

          Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

          -

          Parameters

          • index: number

          Returns undefined | T

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SearchOptions.html b/docs/interfaces/_internal_.SearchOptions.html deleted file mode 100644 index c58e98f..0000000 --- a/docs/interfaces/_internal_.SearchOptions.html +++ /dev/null @@ -1 +0,0 @@ -SearchOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SearchOptions

        Hierarchy

        • SearchOptions

        Index

        Properties

        Properties

        Optional fuzzy

        fuzzy?: boolean

        Optional limit

        limit?: number

        Optional source

        source?: { deezer?: "album" | "playlist" | "track"; soundcloud?: "albums" | "playlists" | "tracks"; spotify?: "album" | "playlist" | "track"; youtube?: "playlist" | "channel" | "video" }

        Type declaration

        • Optional deezer?: "album" | "playlist" | "track"
        • Optional soundcloud?: "albums" | "playlists" | "tracks"
        • Optional spotify?: "album" | "playlist" | "track"
        • Optional youtube?: "playlist" | "channel" | "video"

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SharedArrayBuffer.html b/docs/interfaces/_internal_.SharedArrayBuffer.html deleted file mode 100644 index 6092521..0000000 --- a/docs/interfaces/_internal_.SharedArrayBuffer.html +++ /dev/null @@ -1,5 +0,0 @@ -SharedArrayBuffer | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SharedArrayBuffer

        Hierarchy

        • SharedArrayBuffer

        Index

        Properties

        Methods

        Properties

        Readonly [species]

        [species]: <internal>.SharedArrayBuffer

        Readonly [toStringTag]

        [toStringTag]: "SharedArrayBuffer"

        Readonly byteLength

        byteLength: number
        -

        Read-only. The length of the ArrayBuffer (in bytes).

        -

        Methods

        slice

        • -

          Returns a section of an SharedArrayBuffer.

          -

          Parameters

          • begin: number
          • Optional end: number

          Returns <internal>.SharedArrayBuffer

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SharedArrayBufferConstructor.html b/docs/interfaces/_internal_.SharedArrayBufferConstructor.html deleted file mode 100644 index 7b2b6fd..0000000 --- a/docs/interfaces/_internal_.SharedArrayBufferConstructor.html +++ /dev/null @@ -1 +0,0 @@ -SharedArrayBufferConstructor | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SharedArrayBufferConstructor

        Hierarchy

        • SharedArrayBufferConstructor

        Index

        Constructors

        Properties

        Constructors

        constructor

        Properties

        Readonly prototype

        prototype: <internal>.SharedArrayBuffer

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SocketConstructorOpts.html b/docs/interfaces/_internal_.SocketConstructorOpts.html deleted file mode 100644 index 90fad25..0000000 --- a/docs/interfaces/_internal_.SocketConstructorOpts.html +++ /dev/null @@ -1 +0,0 @@ -SocketConstructorOpts | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SocketConstructorOpts

        Hierarchy

        • SocketConstructorOpts

        Index

        Properties

        Properties

        Optional allowHalfOpen

        allowHalfOpen?: boolean

        Optional fd

        fd?: number

        Optional readable

        readable?: boolean

        Optional writable

        writable?: boolean

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SoundCloudTrackDeprecated.html b/docs/interfaces/_internal_.SoundCloudTrackDeprecated.html deleted file mode 100644 index 8d88cf3..0000000 --- a/docs/interfaces/_internal_.SoundCloudTrackDeprecated.html +++ /dev/null @@ -1,7 +0,0 @@ -SoundCloudTrackDeprecated | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SoundCloudTrackDeprecated

        Hierarchy

        • SoundCloudTrackDeprecated

        Index

        Properties

        Properties

        fetched

        fetched: boolean
        -

        SoundCloud Track fetched status

        -

        id

        id: number
        -

        SoundCloud Track ID

        -

        type

        type: "track"
        -

        SoundCloud Class type. == "track"

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SoundCloudTrackFormat.html b/docs/interfaces/_internal_.SoundCloudTrackFormat.html deleted file mode 100644 index a8307e5..0000000 --- a/docs/interfaces/_internal_.SoundCloudTrackFormat.html +++ /dev/null @@ -1,11 +0,0 @@ -SoundCloudTrackFormat | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SoundCloudTrackFormat

        Hierarchy

        • SoundCloudTrackFormat

        Index

        Properties

        Properties

        duration

        duration: number
        -

        SoundCloud Track Format Duration

        -

        format

        format: { mime_type: string; protocol: string }
        -

        SoundCloud Track Format data containing protocol and mime_type

        -

        Type declaration

        • mime_type: string
        • protocol: string

        preset

        preset: string
        -

        SoundCloud Track Format preset

        -

        quality

        quality: string
        -

        SoundCloud Track Format quality

        -

        url

        url: string
        -

        SoundCloud Track Format Url

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SoundCloudUser.html b/docs/interfaces/_internal_.SoundCloudUser.html deleted file mode 100644 index 204039b..0000000 --- a/docs/interfaces/_internal_.SoundCloudUser.html +++ /dev/null @@ -1,21 +0,0 @@ -SoundCloudUser | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SoundCloudUser

        Hierarchy

        • SoundCloudUser

        Index

        Properties

        Properties

        description

        description: string
        -

        SoundCloud User Description

        -

        first_name

        first_name: string
        -

        SoundCloud User First Name

        -

        full_name

        full_name: string
        -

        SoundCloud User Full Name

        -

        id

        id: string
        -

        SoundCloud User ID

        -

        last_name

        last_name: string
        -

        SoundCloud User Last Name

        -

        name

        name: string
        -

        SoundCloud User Name

        -

        thumbnail

        thumbnail: string
        -

        SoundCloud User thumbnail URL

        -

        type

        type: "playlist" | "track" | "user"
        -

        SoundCloud Class type. == "user"

        -

        url

        url: string
        -

        SoundCloud User URL

        -

        verified

        verified: boolean
        -

        SoundCloud User Verified status

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SoundTrackJSON.html b/docs/interfaces/_internal_.SoundTrackJSON.html deleted file mode 100644 index 0db51b8..0000000 --- a/docs/interfaces/_internal_.SoundTrackJSON.html +++ /dev/null @@ -1,21 +0,0 @@ -SoundTrackJSON | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SoundTrackJSON

        Hierarchy

        • SoundTrackJSON

        Index

        Properties

        Properties

        durationInMs

        durationInMs: number
        -

        SoundCloud Track Duration in miili seconds

        -

        durationInSec

        durationInSec: number
        -

        SoundCloud Track Duration in seconds

        -

        fetched

        fetched: boolean
        -

        SoundCloud Track fetched status

        -

        formats

        formats: SoundCloudTrackFormat[]
        -

        SoundCloud Track formats data

        -

        id

        id: number
        -

        SoundCloud Track ID

        -

        name

        name: string
        -

        SoundCloud Track Name

        -

        publisher

        publisher: null | { artist: string; contains_music: boolean; id: number; name: string; writer_composer: string }
        -

        SoundCloud Track Publisher Data

        -

        thumbnail

        thumbnail: string
        -

        SoundCloud Track thumbnail

        -

        url

        url: string
        -

        SoundCloud Track url

        -

        user

        user: SoundCloudUser
        -

        SoundCloud Track user data

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SpotifyArtists.html b/docs/interfaces/_internal_.SpotifyArtists.html deleted file mode 100644 index 00f4260..0000000 --- a/docs/interfaces/_internal_.SpotifyArtists.html +++ /dev/null @@ -1,7 +0,0 @@ -SpotifyArtists | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SpotifyArtists

        Hierarchy

        • SpotifyArtists

        Index

        Properties

        Properties

        id

        id: string
        -

        Spotify Artist ID

        -

        name

        name: string
        -

        Spotify Artist Name

        -

        url

        url: string
        -

        Spotify Artist Url

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SpotifyCopyright.html b/docs/interfaces/_internal_.SpotifyCopyright.html deleted file mode 100644 index 093ac41..0000000 --- a/docs/interfaces/_internal_.SpotifyCopyright.html +++ /dev/null @@ -1,5 +0,0 @@ -SpotifyCopyright | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SpotifyCopyright

        Hierarchy

        • SpotifyCopyright

        Index

        Properties

        Properties

        text

        text: string
        -

        Spotify Copyright Text

        -

        type

        type: string
        -

        Spotify Copyright Type

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SpotifyDataOptions.html b/docs/interfaces/_internal_.SpotifyDataOptions.html deleted file mode 100644 index d3e9766..0000000 --- a/docs/interfaces/_internal_.SpotifyDataOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -SpotifyDataOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SpotifyDataOptions

        -

        Spotify Data options that are stored in spotify.data file.

        -

        Hierarchy

        • SpotifyDataOptions

        Index

        Properties

        Properties

        Optional access_token

        access_token?: string

        Optional authorization_code

        authorization_code?: string

        client_id

        client_id: string

        client_secret

        client_secret: string

        Optional expires_in

        expires_in?: number

        Optional expiry

        expiry?: number

        Optional file

        file?: boolean

        Optional market

        market?: string

        Optional redirect_url

        redirect_url?: string

        Optional refresh_token

        refresh_token?: string

        Optional token_type

        token_type?: string

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SpotifyThumbnail.html b/docs/interfaces/_internal_.SpotifyThumbnail.html deleted file mode 100644 index 87fd582..0000000 --- a/docs/interfaces/_internal_.SpotifyThumbnail.html +++ /dev/null @@ -1,7 +0,0 @@ -SpotifyThumbnail | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SpotifyThumbnail

        Hierarchy

        • SpotifyThumbnail

        Index

        Properties

        Properties

        height

        height: number
        -

        Spotify Thumbnail height

        -

        url

        url: string
        -

        Spotify Thumbnail url

        -

        width

        width: number
        -

        Spotify Thumbnail width

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.SpotifyTrackAlbum.html b/docs/interfaces/_internal_.SpotifyTrackAlbum.html deleted file mode 100644 index a49d403..0000000 --- a/docs/interfaces/_internal_.SpotifyTrackAlbum.html +++ /dev/null @@ -1,13 +0,0 @@ -SpotifyTrackAlbum | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface SpotifyTrackAlbum

        Hierarchy

        • SpotifyTrackAlbum

        Index

        Properties

        Properties

        id

        id: string
        -

        Spotify Track Album id

        -

        name

        name: string
        -

        Spotify Track Album name

        -

        release_date

        release_date: string
        -

        Spotify Track Album release date

        -

        release_date_precision

        release_date_precision: string
        -

        Spotify Track Album release date precise

        -

        total_tracks

        total_tracks: number
        -

        Spotify Track Album total tracks number

        -

        url

        url: string
        -

        Spotify Track Album url

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.StaticEventEmitterOptions.html b/docs/interfaces/_internal_.StaticEventEmitterOptions.html deleted file mode 100644 index 9c0b935..0000000 --- a/docs/interfaces/_internal_.StaticEventEmitterOptions.html +++ /dev/null @@ -1 +0,0 @@ -StaticEventEmitterOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface StaticEventEmitterOptions

        Hierarchy

        • StaticEventEmitterOptions

        Index

        Properties

        Properties

        Optional signal

        signal?: <internal>.AbortSignal

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.StreamOptions-1.html b/docs/interfaces/_internal_.StreamOptions-1.html deleted file mode 100644 index 7d36ec0..0000000 --- a/docs/interfaces/_internal_.StreamOptions-1.html +++ /dev/null @@ -1,3 +0,0 @@ -StreamOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface StreamOptions<T>

        Type parameters

        Hierarchy

        Index

        Properties

        Methods

        Properties

        Optional autoDestroy

        autoDestroy?: boolean

        Optional emitClose

        emitClose?: boolean

        Optional highWaterMark

        highWaterMark?: number

        Optional objectMode

        objectMode?: boolean

        Optional signal

        signal?: <internal>.AbortSignal
        -

        When provided the corresponding AbortController can be used to cancel an asynchronous action.

        -

        Methods

        Optional construct

        Optional destroy

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.StreamOptions.html b/docs/interfaces/_internal_.StreamOptions.html deleted file mode 100644 index 44e4ddc..0000000 --- a/docs/interfaces/_internal_.StreamOptions.html +++ /dev/null @@ -1 +0,0 @@ -StreamOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface StreamOptions

        Hierarchy

        • StreamOptions

        Index

        Properties

        Properties

        Optional htmldata

        htmldata?: boolean

        Optional proxy

        proxy?: ProxyOptions[]

        Optional quality

        quality?: number

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.TcpSocketConnectOpts.html b/docs/interfaces/_internal_.TcpSocketConnectOpts.html deleted file mode 100644 index f87b6c6..0000000 --- a/docs/interfaces/_internal_.TcpSocketConnectOpts.html +++ /dev/null @@ -1,5 +0,0 @@ -TcpSocketConnectOpts | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TcpSocketConnectOpts

        Hierarchy

        Index

        Properties

        Properties

        Optional family

        family?: number

        Optional hints

        hints?: number

        Optional host

        host?: string

        Optional localAddress

        localAddress?: string

        Optional localPort

        localPort?: number

        Optional lookup

        lookup?: LookupFunction

        Optional onread

        onread?: OnReadOpts
        -

        If specified, incoming data is stored in a single buffer and passed to the supplied callback when data arrives on the socket. -Note: this will cause the streaming functionality to not provide any data, however events like 'error', 'end', and 'close' will -still be emitted as normal and methods like pause() and resume() will also behave as expected.

        -

        port

        port: number

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.ThisType.html b/docs/interfaces/_internal_.ThisType.html deleted file mode 100644 index 1075a77..0000000 --- a/docs/interfaces/_internal_.ThisType.html +++ /dev/null @@ -1,3 +0,0 @@ -ThisType | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ThisType<T>

        -

        Marker for contextual 'this' type

        -

        Type parameters

        • T

        Hierarchy

        • ThisType

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Timer-1.html b/docs/interfaces/_internal_.Timer-1.html deleted file mode 100644 index 28a9b69..0000000 --- a/docs/interfaces/_internal_.Timer-1.html +++ /dev/null @@ -1 +0,0 @@ -Timer | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Timer

        Hierarchy

        Index

        Methods

        Methods

        [toPrimitive]

        • [toPrimitive](): number

        • Returns number

        hasRef

        • hasRef(): boolean

        • Returns boolean

        ref

        refresh

        unref

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.TrackJSON.html b/docs/interfaces/_internal_.TrackJSON.html deleted file mode 100644 index 7e5e0f2..0000000 --- a/docs/interfaces/_internal_.TrackJSON.html +++ /dev/null @@ -1,19 +0,0 @@ -TrackJSON | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TrackJSON

        Hierarchy

        • TrackJSON

        Index

        Properties

        Properties

        album

        album: undefined | SpotifyTrackAlbum
        -

        Spotify Track Album data

        -

        artists

        artists: SpotifyArtists[]
        -

        Spotify Track Artists data [ array ]

        -

        durationInMs

        durationInMs: number
        -

        Spotify Track Duration in milli seconds

        -

        durationInSec

        durationInSec: number
        -

        Spotify Track Duration in seconds

        -

        explicit

        explicit: boolean
        -

        Spotify Track explicit info.

        -

        id

        id: string
        -

        Spotify Track ID

        -

        name

        name: string
        -

        Spotify Track Name

        -

        thumbnail

        thumbnail: undefined | SpotifyThumbnail
        -

        Spotify Track Thumbnail Data

        -

        url

        url: string
        -

        Spotify Track url

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.TypedPropertyDescriptor.html b/docs/interfaces/_internal_.TypedPropertyDescriptor.html deleted file mode 100644 index 6613693..0000000 --- a/docs/interfaces/_internal_.TypedPropertyDescriptor.html +++ /dev/null @@ -1 +0,0 @@ -TypedPropertyDescriptor | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TypedPropertyDescriptor<T>

        Type parameters

        • T

        Hierarchy

        • TypedPropertyDescriptor

        Index

        Properties

        Methods

        Properties

        Optional configurable

        configurable?: boolean

        Optional enumerable

        enumerable?: boolean

        Optional value

        value?: T

        Optional writable

        writable?: boolean

        Methods

        Optional get

        • get(): T

        • Returns T

        Optional set

        • set(value: T): void

        • Parameters

          • value: T

          Returns void

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Uint16Array.html b/docs/interfaces/_internal_.Uint16Array.html deleted file mode 100644 index 474f127..0000000 --- a/docs/interfaces/_internal_.Uint16Array.html +++ /dev/null @@ -1,204 +0,0 @@ -Uint16Array | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Uint16Array

        -

        A typed array of 16-bit unsigned integer values. The contents are initialized to 0. If the -requested number of bytes could not be allocated an exception is raised.

        -

        Hierarchy

        Indexable

        [index: number]: number

        Index

        Properties

        Methods

        Properties

        Readonly BYTES_PER_ELEMENT

        BYTES_PER_ELEMENT: number
        -

        The size in bytes of each element in the array.

        -

        Readonly [toStringTag]

        [toStringTag]: "Uint16Array"

        Readonly buffer

        buffer: ArrayBufferLike
        -

        The ArrayBuffer instance referenced by the array.

        -

        Readonly byteLength

        byteLength: number
        -

        The length in bytes of the array.

        -

        Readonly byteOffset

        byteOffset: number
        -

        The offset in bytes of the array.

        -

        Readonly length

        length: number
        -

        The length of the array.

        -

        Methods

        [iterator]

        • Returns IterableIterator<number>

        at

        • at(index: number): undefined | number
        • -

          Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

          -

          Parameters

          • index: number

          Returns undefined | number

        copyWithin

        • -

          Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

          -

          Parameters

          • target: number
            -

            If target is negative, it is treated as length+target where length is the -length of the array.

            -
          • start: number
            -

            If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

            -
          • Optional end: number
            -

            If not specified, length of the this object is used as its default value.

            -

          Returns <internal>.Uint16Array

        entries

        • -

          Returns an array of key, value pairs for every entry in the array

          -

          Returns IterableIterator<[number, number]>

        every

        • every(predicate: (value: number, index: number, array: <internal>.Uint16Array) => unknown, thisArg?: any): boolean
        • -

          Determines whether all the members of an array satisfy the specified test.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint16Array) => unknown
            -

            A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns boolean

        fill

        • -

          Changes all array elements from start to end index to a static value and returns the modified array

          -

          Parameters

          • value: number
            -

            value to fill array section with

            -
          • Optional start: number
            -

            index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

            -
          • Optional end: number
            -

            index to stop filling the array at. If end is negative, it is treated as -length+end.

            -

          Returns <internal>.Uint16Array

        filter

        • -

          Returns the elements of an array that meet the condition specified in a callback function.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint16Array) => any
            -

            A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns <internal>.Uint16Array

        find

        • find(predicate: (value: number, index: number, obj: <internal>.Uint16Array) => boolean, thisArg?: any): undefined | number
        • -

          Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

          -

          Parameters

          • predicate: (value: number, index: number, obj: <internal>.Uint16Array) => boolean
            -

            find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

            -
          • Optional thisArg: any
            -

            If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

            -

          Returns undefined | number

        findIndex

        • findIndex(predicate: (value: number, index: number, obj: <internal>.Uint16Array) => boolean, thisArg?: any): number
        • -

          Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

          -

          Parameters

          • predicate: (value: number, index: number, obj: <internal>.Uint16Array) => boolean
            -

            find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

            -
          • Optional thisArg: any
            -

            If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

            -

          Returns number

        forEach

        • forEach(callbackfn: (value: number, index: number, array: <internal>.Uint16Array) => void, thisArg?: any): void
        • -

          Performs the specified action for each element in an array.

          -

          Parameters

          • callbackfn: (value: number, index: number, array: <internal>.Uint16Array) => void
            -

            A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns void

        includes

        • includes(searchElement: number, fromIndex?: number): boolean
        • -

          Determines whether an array includes a certain element, returning true or false as appropriate.

          -

          Parameters

          • searchElement: number
            -

            The element to search for.

            -
          • Optional fromIndex: number
            -

            The position in this array at which to begin searching for searchElement.

            -

          Returns boolean

        indexOf

        • indexOf(searchElement: number, fromIndex?: number): number
        • -

          Returns the index of the first occurrence of a value in an array.

          -

          Parameters

          • searchElement: number
            -

            The value to locate in the array.

            -
          • Optional fromIndex: number
            -

            The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

            -

          Returns number

        join

        • join(separator?: string): string
        • -

          Adds all the elements of an array separated by the specified separator string.

          -

          Parameters

          • Optional separator: string
            -

            A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

            -

          Returns string

        keys

        • -

          Returns an list of keys in the array

          -

          Returns IterableIterator<number>

        lastIndexOf

        • lastIndexOf(searchElement: number, fromIndex?: number): number
        • -

          Returns the index of the last occurrence of a value in an array.

          -

          Parameters

          • searchElement: number
            -

            The value to locate in the array.

            -
          • Optional fromIndex: number
            -

            The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

            -

          Returns number

        map

        • -

          Calls a defined callback function on each element of an array, and returns an array that -contains the results.

          -

          Parameters

          • callbackfn: (value: number, index: number, array: <internal>.Uint16Array) => number
            -

            A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns <internal>.Uint16Array

        reduce

        • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => number): number
        • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => number, initialValue: number): number
        • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => U, initialValue: U): U
        • -

          Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

          -

          Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => number
            -

            A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

            -
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array): number

              • Parameters

                Returns number

          Returns number

        • Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => number
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array): number

              • Parameters

                Returns number

          • initialValue: number

          Returns number

        • -

          Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

          -

          Type parameters

          • U

          Parameters

          • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => U
            -

            A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

            -
          • initialValue: U
            -

            If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

            -

          Returns U

        reduceRight

        • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => number): number
        • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => number, initialValue: number): number
        • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => U, initialValue: U): U
        • -

          Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

          -

          Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => number
            -

            A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

            -
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array): number

              • Parameters

                Returns number

          Returns number

        • Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => number
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint16Array): number

              • Parameters

                Returns number

          • initialValue: number

          Returns number

        • -

          Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

          -

          Type parameters

          • U

          Parameters

          • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint16Array) => U
            -

            A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

            -
          • initialValue: U
            -

            If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

            -

          Returns U

        reverse

        • -

          Reverses the elements in an Array.

          -

          Returns <internal>.Uint16Array

        set

        • set(array: ArrayLike<number>, offset?: number): void
        • -

          Sets a value or an array of values.

          -

          Parameters

          • array: ArrayLike<number>
            -

            A typed or untyped array of values to set.

            -
          • Optional offset: number
            -

            The index in the current array at which the values are to be written.

            -

          Returns void

        slice

        • -

          Returns a section of an array.

          -

          Parameters

          • Optional start: number
            -

            The beginning of the specified portion of the array.

            -
          • Optional end: number
            -

            The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

            -

          Returns <internal>.Uint16Array

        some

        • some(predicate: (value: number, index: number, array: <internal>.Uint16Array) => unknown, thisArg?: any): boolean
        • -

          Determines whether the specified callback function returns true for any element of an array.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint16Array) => unknown
            -

            A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns boolean

        sort

        • -

          Sorts an array.

          -

          Parameters

          • Optional compareFn: (a: number, b: number) => number
            -

            Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

            -
            [11,2,22,1].sort((a, b) => a - b)
-
            -
              • (a: number, b: number): number

              • Parameters

                • a: number
                • b: number

                Returns number

          Returns <internal>.Uint16Array

        subarray

        • -

          Gets a new Uint16Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

          -

          Parameters

          • Optional begin: number
            -

            The index of the beginning of the array.

            -
          • Optional end: number
            -

            The index of the end of the array.

            -

          Returns <internal>.Uint16Array

        toLocaleString

        • toLocaleString(): string
        • -

          Converts a number to a string by using the current locale.

          -

          Returns string

        toString

        • toString(): string
        • -

          Returns a string representation of an array.

          -

          Returns string

        valueOf

        • -

          Returns the primitive value of the specified object.

          -

          Returns <internal>.Uint16Array

        values

        • -

          Returns an list of values in the array

          -

          Returns IterableIterator<number>

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Uint16ArrayConstructor.html b/docs/interfaces/_internal_.Uint16ArrayConstructor.html deleted file mode 100644 index d37a605..0000000 --- a/docs/interfaces/_internal_.Uint16ArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Uint16ArrayConstructor | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Uint16ArrayConstructor

        Hierarchy

        • Uint16ArrayConstructor

        Index

        Constructors

        Properties

        Methods

        Constructors

        constructor

        Properties

        Readonly BYTES_PER_ELEMENT

        BYTES_PER_ELEMENT: number
        -

        The size in bytes of each element in the array.

        -

        Readonly prototype

        prototype: <internal>.Uint16Array

        Methods

        from

        • -

          Creates an array from an array-like or iterable object.

          -

          Parameters

          • arrayLike: ArrayLike<number>
            -

            An array-like or iterable object to convert to an array.

            -

          Returns <internal>.Uint16Array

        • -

          Creates an array from an array-like or iterable object.

          -

          Type parameters

          • T

          Parameters

          • arrayLike: ArrayLike<T>
            -

            An array-like or iterable object to convert to an array.

            -
          • mapfn: (v: T, k: number) => number
            -

            A mapping function to call on every element of the array.

            -
              • (v: T, k: number): number

              • Parameters

                • v: T
                • k: number

                Returns number

          • Optional thisArg: any
            -

            Value of 'this' used to invoke the mapfn.

            -

          Returns <internal>.Uint16Array

        • -

          Creates an array from an array-like or iterable object.

          -

          Parameters

          • arrayLike: Iterable<number>
            -

            An array-like or iterable object to convert to an array.

            -
          • Optional mapfn: (v: number, k: number) => number
            -

            A mapping function to call on every element of the array.

            -
              • (v: number, k: number): number

              • Parameters

                • v: number
                • k: number

                Returns number

          • Optional thisArg: any
            -

            Value of 'this' used to invoke the mapfn.

            -

          Returns <internal>.Uint16Array

        of

        • -

          Returns a new array from a set of elements.

          -

          Parameters

          • Rest ...items: number[]
            -

            A set of elements to include in the new array object.

            -

          Returns <internal>.Uint16Array

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Uint32Array.html b/docs/interfaces/_internal_.Uint32Array.html deleted file mode 100644 index 5149da6..0000000 --- a/docs/interfaces/_internal_.Uint32Array.html +++ /dev/null @@ -1,204 +0,0 @@ -Uint32Array | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Uint32Array

        -

        A typed array of 32-bit unsigned integer values. The contents are initialized to 0. If the -requested number of bytes could not be allocated an exception is raised.

        -

        Hierarchy

        Indexable

        [index: number]: number

        Index

        Properties

        Methods

        Properties

        Readonly BYTES_PER_ELEMENT

        BYTES_PER_ELEMENT: number
        -

        The size in bytes of each element in the array.

        -

        Readonly [toStringTag]

        [toStringTag]: "Uint32Array"

        Readonly buffer

        buffer: ArrayBufferLike
        -

        The ArrayBuffer instance referenced by the array.

        -

        Readonly byteLength

        byteLength: number
        -

        The length in bytes of the array.

        -

        Readonly byteOffset

        byteOffset: number
        -

        The offset in bytes of the array.

        -

        Readonly length

        length: number
        -

        The length of the array.

        -

        Methods

        [iterator]

        • Returns IterableIterator<number>

        at

        • at(index: number): undefined | number
        • -

          Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

          -

          Parameters

          • index: number

          Returns undefined | number

        copyWithin

        • -

          Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

          -

          Parameters

          • target: number
            -

            If target is negative, it is treated as length+target where length is the -length of the array.

            -
          • start: number
            -

            If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

            -
          • Optional end: number
            -

            If not specified, length of the this object is used as its default value.

            -

          Returns <internal>.Uint32Array

        entries

        • -

          Returns an array of key, value pairs for every entry in the array

          -

          Returns IterableIterator<[number, number]>

        every

        • every(predicate: (value: number, index: number, array: <internal>.Uint32Array) => unknown, thisArg?: any): boolean
        • -

          Determines whether all the members of an array satisfy the specified test.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint32Array) => unknown
            -

            A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns boolean

        fill

        • -

          Changes all array elements from start to end index to a static value and returns the modified array

          -

          Parameters

          • value: number
            -

            value to fill array section with

            -
          • Optional start: number
            -

            index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

            -
          • Optional end: number
            -

            index to stop filling the array at. If end is negative, it is treated as -length+end.

            -

          Returns <internal>.Uint32Array

        filter

        • -

          Returns the elements of an array that meet the condition specified in a callback function.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint32Array) => any
            -

            A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns <internal>.Uint32Array

        find

        • find(predicate: (value: number, index: number, obj: <internal>.Uint32Array) => boolean, thisArg?: any): undefined | number
        • -

          Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

          -

          Parameters

          • predicate: (value: number, index: number, obj: <internal>.Uint32Array) => boolean
            -

            find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

            -
          • Optional thisArg: any
            -

            If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

            -

          Returns undefined | number

        findIndex

        • findIndex(predicate: (value: number, index: number, obj: <internal>.Uint32Array) => boolean, thisArg?: any): number
        • -

          Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

          -

          Parameters

          • predicate: (value: number, index: number, obj: <internal>.Uint32Array) => boolean
            -

            find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

            -
          • Optional thisArg: any
            -

            If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

            -

          Returns number

        forEach

        • forEach(callbackfn: (value: number, index: number, array: <internal>.Uint32Array) => void, thisArg?: any): void
        • -

          Performs the specified action for each element in an array.

          -

          Parameters

          • callbackfn: (value: number, index: number, array: <internal>.Uint32Array) => void
            -

            A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns void

        includes

        • includes(searchElement: number, fromIndex?: number): boolean
        • -

          Determines whether an array includes a certain element, returning true or false as appropriate.

          -

          Parameters

          • searchElement: number
            -

            The element to search for.

            -
          • Optional fromIndex: number
            -

            The position in this array at which to begin searching for searchElement.

            -

          Returns boolean

        indexOf

        • indexOf(searchElement: number, fromIndex?: number): number
        • -

          Returns the index of the first occurrence of a value in an array.

          -

          Parameters

          • searchElement: number
            -

            The value to locate in the array.

            -
          • Optional fromIndex: number
            -

            The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

            -

          Returns number

        join

        • join(separator?: string): string
        • -

          Adds all the elements of an array separated by the specified separator string.

          -

          Parameters

          • Optional separator: string
            -

            A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

            -

          Returns string

        keys

        • -

          Returns an list of keys in the array

          -

          Returns IterableIterator<number>

        lastIndexOf

        • lastIndexOf(searchElement: number, fromIndex?: number): number
        • -

          Returns the index of the last occurrence of a value in an array.

          -

          Parameters

          • searchElement: number
            -

            The value to locate in the array.

            -
          • Optional fromIndex: number
            -

            The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

            -

          Returns number

        map

        • -

          Calls a defined callback function on each element of an array, and returns an array that -contains the results.

          -

          Parameters

          • callbackfn: (value: number, index: number, array: <internal>.Uint32Array) => number
            -

            A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns <internal>.Uint32Array

        reduce

        • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => number): number
        • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => number, initialValue: number): number
        • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => U, initialValue: U): U
        • -

          Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

          -

          Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => number
            -

            A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

            -
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array): number

              • Parameters

                Returns number

          Returns number

        • Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => number
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array): number

              • Parameters

                Returns number

          • initialValue: number

          Returns number

        • -

          Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

          -

          Type parameters

          • U

          Parameters

          • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => U
            -

            A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

            -
          • initialValue: U
            -

            If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

            -

          Returns U

        reduceRight

        • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => number): number
        • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => number, initialValue: number): number
        • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => U, initialValue: U): U
        • -

          Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

          -

          Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => number
            -

            A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

            -
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array): number

              • Parameters

                Returns number

          Returns number

        • Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => number
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint32Array): number

              • Parameters

                Returns number

          • initialValue: number

          Returns number

        • -

          Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

          -

          Type parameters

          • U

          Parameters

          • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint32Array) => U
            -

            A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

            -
          • initialValue: U
            -

            If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

            -

          Returns U

        reverse

        • -

          Reverses the elements in an Array.

          -

          Returns <internal>.Uint32Array

        set

        • set(array: ArrayLike<number>, offset?: number): void
        • -

          Sets a value or an array of values.

          -

          Parameters

          • array: ArrayLike<number>
            -

            A typed or untyped array of values to set.

            -
          • Optional offset: number
            -

            The index in the current array at which the values are to be written.

            -

          Returns void

        slice

        • -

          Returns a section of an array.

          -

          Parameters

          • Optional start: number
            -

            The beginning of the specified portion of the array.

            -
          • Optional end: number
            -

            The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

            -

          Returns <internal>.Uint32Array

        some

        • some(predicate: (value: number, index: number, array: <internal>.Uint32Array) => unknown, thisArg?: any): boolean
        • -

          Determines whether the specified callback function returns true for any element of an array.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint32Array) => unknown
            -

            A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns boolean

        sort

        • -

          Sorts an array.

          -

          Parameters

          • Optional compareFn: (a: number, b: number) => number
            -

            Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

            -
            [11,2,22,1].sort((a, b) => a - b)
-
            -
              • (a: number, b: number): number

              • Parameters

                • a: number
                • b: number

                Returns number

          Returns <internal>.Uint32Array

        subarray

        • -

          Gets a new Uint32Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

          -

          Parameters

          • Optional begin: number
            -

            The index of the beginning of the array.

            -
          • Optional end: number
            -

            The index of the end of the array.

            -

          Returns <internal>.Uint32Array

        toLocaleString

        • toLocaleString(): string
        • -

          Converts a number to a string by using the current locale.

          -

          Returns string

        toString

        • toString(): string
        • -

          Returns a string representation of an array.

          -

          Returns string

        valueOf

        • -

          Returns the primitive value of the specified object.

          -

          Returns <internal>.Uint32Array

        values

        • -

          Returns an list of values in the array

          -

          Returns IterableIterator<number>

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Uint32ArrayConstructor.html b/docs/interfaces/_internal_.Uint32ArrayConstructor.html deleted file mode 100644 index 25a57b0..0000000 --- a/docs/interfaces/_internal_.Uint32ArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Uint32ArrayConstructor | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Uint32ArrayConstructor

        Hierarchy

        • Uint32ArrayConstructor

        Index

        Constructors

        Properties

        Methods

        Constructors

        constructor

        Properties

        Readonly BYTES_PER_ELEMENT

        BYTES_PER_ELEMENT: number
        -

        The size in bytes of each element in the array.

        -

        Readonly prototype

        prototype: <internal>.Uint32Array

        Methods

        from

        • -

          Creates an array from an array-like or iterable object.

          -

          Parameters

          • arrayLike: ArrayLike<number>
            -

            An array-like or iterable object to convert to an array.

            -

          Returns <internal>.Uint32Array

        • -

          Creates an array from an array-like or iterable object.

          -

          Type parameters

          • T

          Parameters

          • arrayLike: ArrayLike<T>
            -

            An array-like or iterable object to convert to an array.

            -
          • mapfn: (v: T, k: number) => number
            -

            A mapping function to call on every element of the array.

            -
              • (v: T, k: number): number

              • Parameters

                • v: T
                • k: number

                Returns number

          • Optional thisArg: any
            -

            Value of 'this' used to invoke the mapfn.

            -

          Returns <internal>.Uint32Array

        • -

          Creates an array from an array-like or iterable object.

          -

          Parameters

          • arrayLike: Iterable<number>
            -

            An array-like or iterable object to convert to an array.

            -
          • Optional mapfn: (v: number, k: number) => number
            -

            A mapping function to call on every element of the array.

            -
              • (v: number, k: number): number

              • Parameters

                • v: number
                • k: number

                Returns number

          • Optional thisArg: any
            -

            Value of 'this' used to invoke the mapfn.

            -

          Returns <internal>.Uint32Array

        of

        • -

          Returns a new array from a set of elements.

          -

          Parameters

          • Rest ...items: number[]
            -

            A set of elements to include in the new array object.

            -

          Returns <internal>.Uint32Array

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Uint8Array.html b/docs/interfaces/_internal_.Uint8Array.html deleted file mode 100644 index 8911b00..0000000 --- a/docs/interfaces/_internal_.Uint8Array.html +++ /dev/null @@ -1,204 +0,0 @@ -Uint8Array | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Uint8Array

        -

        A typed array of 8-bit unsigned integer values. The contents are initialized to 0. If the -requested number of bytes could not be allocated an exception is raised.

        -

        Hierarchy

        Indexable

        [index: number]: number

        Index

        Properties

        Methods

        Properties

        Readonly BYTES_PER_ELEMENT

        BYTES_PER_ELEMENT: number
        -

        The size in bytes of each element in the array.

        -

        Readonly [toStringTag]

        [toStringTag]: "Uint8Array"

        Readonly buffer

        buffer: ArrayBufferLike
        -

        The ArrayBuffer instance referenced by the array.

        -

        Readonly byteLength

        byteLength: number
        -

        The length in bytes of the array.

        -

        Readonly byteOffset

        byteOffset: number
        -

        The offset in bytes of the array.

        -

        Readonly length

        length: number
        -

        The length of the array.

        -

        Methods

        [iterator]

        • Returns IterableIterator<number>

        at

        • at(index: number): undefined | number
        • -

          Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

          -

          Parameters

          • index: number

          Returns undefined | number

        copyWithin

        • -

          Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

          -

          Parameters

          • target: number
            -

            If target is negative, it is treated as length+target where length is the -length of the array.

            -
          • start: number
            -

            If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

            -
          • Optional end: number
            -

            If not specified, length of the this object is used as its default value.

            -

          Returns <internal>.Uint8Array

        entries

        • -

          Returns an array of key, value pairs for every entry in the array

          -

          Returns IterableIterator<[number, number]>

        every

        • every(predicate: (value: number, index: number, array: <internal>.Uint8Array) => unknown, thisArg?: any): boolean
        • -

          Determines whether all the members of an array satisfy the specified test.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint8Array) => unknown
            -

            A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns boolean

        fill

        • -

          Changes all array elements from start to end index to a static value and returns the modified array

          -

          Parameters

          • value: number
            -

            value to fill array section with

            -
          • Optional start: number
            -

            index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

            -
          • Optional end: number
            -

            index to stop filling the array at. If end is negative, it is treated as -length+end.

            -

          Returns <internal>.Uint8Array

        filter

        • -

          Returns the elements of an array that meet the condition specified in a callback function.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint8Array) => any
            -

            A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns <internal>.Uint8Array

        find

        • find(predicate: (value: number, index: number, obj: <internal>.Uint8Array) => boolean, thisArg?: any): undefined | number
        • -

          Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

          -

          Parameters

          • predicate: (value: number, index: number, obj: <internal>.Uint8Array) => boolean
            -

            find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

            -
          • Optional thisArg: any
            -

            If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

            -

          Returns undefined | number

        findIndex

        • findIndex(predicate: (value: number, index: number, obj: <internal>.Uint8Array) => boolean, thisArg?: any): number
        • -

          Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

          -

          Parameters

          • predicate: (value: number, index: number, obj: <internal>.Uint8Array) => boolean
            -

            find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

            -
          • Optional thisArg: any
            -

            If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

            -

          Returns number

        forEach

        • forEach(callbackfn: (value: number, index: number, array: <internal>.Uint8Array) => void, thisArg?: any): void
        • -

          Performs the specified action for each element in an array.

          -

          Parameters

          • callbackfn: (value: number, index: number, array: <internal>.Uint8Array) => void
            -

            A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns void

        includes

        • includes(searchElement: number, fromIndex?: number): boolean
        • -

          Determines whether an array includes a certain element, returning true or false as appropriate.

          -

          Parameters

          • searchElement: number
            -

            The element to search for.

            -
          • Optional fromIndex: number
            -

            The position in this array at which to begin searching for searchElement.

            -

          Returns boolean

        indexOf

        • indexOf(searchElement: number, fromIndex?: number): number
        • -

          Returns the index of the first occurrence of a value in an array.

          -

          Parameters

          • searchElement: number
            -

            The value to locate in the array.

            -
          • Optional fromIndex: number
            -

            The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

            -

          Returns number

        join

        • join(separator?: string): string
        • -

          Adds all the elements of an array separated by the specified separator string.

          -

          Parameters

          • Optional separator: string
            -

            A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

            -

          Returns string

        keys

        • -

          Returns an list of keys in the array

          -

          Returns IterableIterator<number>

        lastIndexOf

        • lastIndexOf(searchElement: number, fromIndex?: number): number
        • -

          Returns the index of the last occurrence of a value in an array.

          -

          Parameters

          • searchElement: number
            -

            The value to locate in the array.

            -
          • Optional fromIndex: number
            -

            The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

            -

          Returns number

        map

        • -

          Calls a defined callback function on each element of an array, and returns an array that -contains the results.

          -

          Parameters

          • callbackfn: (value: number, index: number, array: <internal>.Uint8Array) => number
            -

            A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns <internal>.Uint8Array

        reduce

        • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number): number
        • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number, initialValue: number): number
        • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => U, initialValue: U): U
        • -

          Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

          -

          Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number
            -

            A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

            -
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array): number

              • Parameters

                Returns number

          Returns number

        • Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array): number

              • Parameters

                Returns number

          • initialValue: number

          Returns number

        • -

          Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

          -

          Type parameters

          • U

          Parameters

          • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => U
            -

            A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

            -
          • initialValue: U
            -

            If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

            -

          Returns U

        reduceRight

        • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number): number
        • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number, initialValue: number): number
        • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => U, initialValue: U): U
        • -

          Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

          -

          Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number
            -

            A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

            -
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array): number

              • Parameters

                Returns number

          Returns number

        • Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => number
              • (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8Array): number

              • Parameters

                Returns number

          • initialValue: number

          Returns number

        • -

          Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

          -

          Type parameters

          • U

          Parameters

          • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8Array) => U
            -

            A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

            -
          • initialValue: U
            -

            If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

            -

          Returns U

        reverse

        • -

          Reverses the elements in an Array.

          -

          Returns <internal>.Uint8Array

        set

        • set(array: ArrayLike<number>, offset?: number): void
        • -

          Sets a value or an array of values.

          -

          Parameters

          • array: ArrayLike<number>
            -

            A typed or untyped array of values to set.

            -
          • Optional offset: number
            -

            The index in the current array at which the values are to be written.

            -

          Returns void

        slice

        • -

          Returns a section of an array.

          -

          Parameters

          • Optional start: number
            -

            The beginning of the specified portion of the array.

            -
          • Optional end: number
            -

            The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

            -

          Returns <internal>.Uint8Array

        some

        • some(predicate: (value: number, index: number, array: <internal>.Uint8Array) => unknown, thisArg?: any): boolean
        • -

          Determines whether the specified callback function returns true for any element of an array.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint8Array) => unknown
            -

            A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns boolean

        sort

        • -

          Sorts an array.

          -

          Parameters

          • Optional compareFn: (a: number, b: number) => number
            -

            Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

            -
            [11,2,22,1].sort((a, b) => a - b)
-
            -
              • (a: number, b: number): number

              • Parameters

                • a: number
                • b: number

                Returns number

          Returns <internal>.Uint8Array

        subarray

        • -

          Gets a new Uint8Array view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

          -

          Parameters

          • Optional begin: number
            -

            The index of the beginning of the array.

            -
          • Optional end: number
            -

            The index of the end of the array.

            -

          Returns <internal>.Uint8Array

        toLocaleString

        • toLocaleString(): string
        • -

          Converts a number to a string by using the current locale.

          -

          Returns string

        toString

        • toString(): string
        • -

          Returns a string representation of an array.

          -

          Returns string

        valueOf

        • -

          Returns the primitive value of the specified object.

          -

          Returns <internal>.Uint8Array

        values

        • -

          Returns an list of values in the array

          -

          Returns IterableIterator<number>

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Uint8ArrayConstructor.html b/docs/interfaces/_internal_.Uint8ArrayConstructor.html deleted file mode 100644 index a3a49d1..0000000 --- a/docs/interfaces/_internal_.Uint8ArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Uint8ArrayConstructor | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Uint8ArrayConstructor

        Hierarchy

        • Uint8ArrayConstructor

        Index

        Constructors

        Properties

        Methods

        Constructors

        constructor

        Properties

        Readonly BYTES_PER_ELEMENT

        BYTES_PER_ELEMENT: number
        -

        The size in bytes of each element in the array.

        -

        Readonly prototype

        prototype: <internal>.Uint8Array

        Methods

        from

        • -

          Creates an array from an array-like or iterable object.

          -

          Parameters

          • arrayLike: ArrayLike<number>
            -

            An array-like or iterable object to convert to an array.

            -

          Returns <internal>.Uint8Array

        • -

          Creates an array from an array-like or iterable object.

          -

          Type parameters

          • T

          Parameters

          • arrayLike: ArrayLike<T>
            -

            An array-like or iterable object to convert to an array.

            -
          • mapfn: (v: T, k: number) => number
            -

            A mapping function to call on every element of the array.

            -
              • (v: T, k: number): number

              • Parameters

                • v: T
                • k: number

                Returns number

          • Optional thisArg: any
            -

            Value of 'this' used to invoke the mapfn.

            -

          Returns <internal>.Uint8Array

        • -

          Creates an array from an array-like or iterable object.

          -

          Parameters

          • arrayLike: Iterable<number>
            -

            An array-like or iterable object to convert to an array.

            -
          • Optional mapfn: (v: number, k: number) => number
            -

            A mapping function to call on every element of the array.

            -
              • (v: number, k: number): number

              • Parameters

                • v: number
                • k: number

                Returns number

          • Optional thisArg: any
            -

            Value of 'this' used to invoke the mapfn.

            -

          Returns <internal>.Uint8Array

        of

        • -

          Returns a new array from a set of elements.

          -

          Parameters

          • Rest ...items: number[]
            -

            A set of elements to include in the new array object.

            -

          Returns <internal>.Uint8Array

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Uint8ClampedArray.html b/docs/interfaces/_internal_.Uint8ClampedArray.html deleted file mode 100644 index 4d88696..0000000 --- a/docs/interfaces/_internal_.Uint8ClampedArray.html +++ /dev/null @@ -1,204 +0,0 @@ -Uint8ClampedArray | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Uint8ClampedArray

        -

        A typed array of 8-bit unsigned integer (clamped) values. The contents are initialized to 0. -If the requested number of bytes could not be allocated an exception is raised.

        -

        Hierarchy

        Indexable

        [index: number]: number

        Index

        Properties

        Methods

        Properties

        Readonly BYTES_PER_ELEMENT

        BYTES_PER_ELEMENT: number
        -

        The size in bytes of each element in the array.

        -

        Readonly [toStringTag]

        [toStringTag]: "Uint8ClampedArray"

        Readonly buffer

        buffer: ArrayBufferLike
        -

        The ArrayBuffer instance referenced by the array.

        -

        Readonly byteLength

        byteLength: number
        -

        The length in bytes of the array.

        -

        Readonly byteOffset

        byteOffset: number
        -

        The offset in bytes of the array.

        -

        Readonly length

        length: number
        -

        The length of the array.

        -

        Methods

        [iterator]

        • Returns IterableIterator<number>

        at

        • at(index: number): undefined | number
        • -

          Takes an integer value and returns the item at that index, -allowing for positive and negative integers. -Negative integers count back from the last item in the array.

          -

          Parameters

          • index: number

          Returns undefined | number

        copyWithin

        • -

          Returns the this object after copying a section of the array identified by start and end -to the same array starting at position target

          -

          Parameters

          • target: number
            -

            If target is negative, it is treated as length+target where length is the -length of the array.

            -
          • start: number
            -

            If start is negative, it is treated as length+start. If end is negative, it -is treated as length+end.

            -
          • Optional end: number
            -

            If not specified, length of the this object is used as its default value.

            -

          Returns <internal>.Uint8ClampedArray

        entries

        • -

          Returns an array of key, value pairs for every entry in the array

          -

          Returns IterableIterator<[number, number]>

        every

        • -

          Determines whether all the members of an array satisfy the specified test.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint8ClampedArray) => unknown
            -

            A function that accepts up to three arguments. The every method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value false, or until the end of the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns boolean

        fill

        • -

          Changes all array elements from start to end index to a static value and returns the modified array

          -

          Parameters

          • value: number
            -

            value to fill array section with

            -
          • Optional start: number
            -

            index to start filling the array at. If start is negative, it is treated as -length+start where length is the length of the array.

            -
          • Optional end: number
            -

            index to stop filling the array at. If end is negative, it is treated as -length+end.

            -

          Returns <internal>.Uint8ClampedArray

        filter

        • -

          Returns the elements of an array that meet the condition specified in a callback function.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint8ClampedArray) => any
            -

            A function that accepts up to three arguments. The filter method calls -the predicate function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns <internal>.Uint8ClampedArray

        find

        • -

          Returns the value of the first element in the array where predicate is true, and undefined -otherwise.

          -

          Parameters

          • predicate: (value: number, index: number, obj: <internal>.Uint8ClampedArray) => boolean
            -

            find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, find -immediately returns that element value. Otherwise, find returns undefined.

            -
          • Optional thisArg: any
            -

            If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

            -

          Returns undefined | number

        findIndex

        • -

          Returns the index of the first element in the array where predicate is true, and -1 -otherwise.

          -

          Parameters

          • predicate: (value: number, index: number, obj: <internal>.Uint8ClampedArray) => boolean
            -

            find calls predicate once for each element of the array, in ascending -order, until it finds one where predicate returns true. If such an element is found, -findIndex immediately returns that element index. Otherwise, findIndex returns -1.

            -
          • Optional thisArg: any
            -

            If provided, it will be used as the this value for each invocation of -predicate. If it is not provided, undefined is used instead.

            -

          Returns number

        forEach

        • -

          Performs the specified action for each element in an array.

          -

          Parameters

          • callbackfn: (value: number, index: number, array: <internal>.Uint8ClampedArray) => void
            -

            A function that accepts up to three arguments. forEach calls the -callbackfn function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns void

        includes

        • includes(searchElement: number, fromIndex?: number): boolean
        • -

          Determines whether an array includes a certain element, returning true or false as appropriate.

          -

          Parameters

          • searchElement: number
            -

            The element to search for.

            -
          • Optional fromIndex: number
            -

            The position in this array at which to begin searching for searchElement.

            -

          Returns boolean

        indexOf

        • indexOf(searchElement: number, fromIndex?: number): number
        • -

          Returns the index of the first occurrence of a value in an array.

          -

          Parameters

          • searchElement: number
            -

            The value to locate in the array.

            -
          • Optional fromIndex: number
            -

            The array index at which to begin the search. If fromIndex is omitted, the - search starts at index 0.

            -

          Returns number

        join

        • join(separator?: string): string
        • -

          Adds all the elements of an array separated by the specified separator string.

          -

          Parameters

          • Optional separator: string
            -

            A string used to separate one element of an array from the next in the -resulting String. If omitted, the array elements are separated with a comma.

            -

          Returns string

        keys

        • -

          Returns an list of keys in the array

          -

          Returns IterableIterator<number>

        lastIndexOf

        • lastIndexOf(searchElement: number, fromIndex?: number): number
        • -

          Returns the index of the last occurrence of a value in an array.

          -

          Parameters

          • searchElement: number
            -

            The value to locate in the array.

            -
          • Optional fromIndex: number
            -

            The array index at which to begin the search. If fromIndex is omitted, the -search starts at index 0.

            -

          Returns number

        map

        • -

          Calls a defined callback function on each element of an array, and returns an array that -contains the results.

          -

          Parameters

          • callbackfn: (value: number, index: number, array: <internal>.Uint8ClampedArray) => number
            -

            A function that accepts up to three arguments. The map method calls the -callbackfn function one time for each element in the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the callbackfn function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns <internal>.Uint8ClampedArray

        reduce

        • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => number): number
        • reduce(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => number, initialValue: number): number
        • reduce<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => U, initialValue: U): U
        • -

          Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

          -

          Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => number
            -

            A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

            -

          Returns number

        • Parameters

          Returns number

        • -

          Calls the specified callback function for all the elements in an array. The return value of -the callback function is the accumulated result, and is provided as an argument in the next -call to the callback function.

          -

          Type parameters

          • U

          Parameters

          • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => U
            -

            A function that accepts up to four arguments. The reduce method calls the -callbackfn function one time for each element in the array.

            -
          • initialValue: U
            -

            If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

            -

          Returns U

        reduceRight

        • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => number): number
        • reduceRight(callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => number, initialValue: number): number
        • reduceRight<U>(callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => U, initialValue: U): U
        • -

          Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

          -

          Parameters

          • callbackfn: (previousValue: number, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => number
            -

            A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

            -

          Returns number

        • Parameters

          Returns number

        • -

          Calls the specified callback function for all the elements in an array, in descending order. -The return value of the callback function is the accumulated result, and is provided as an -argument in the next call to the callback function.

          -

          Type parameters

          • U

          Parameters

          • callbackfn: (previousValue: U, currentValue: number, currentIndex: number, array: <internal>.Uint8ClampedArray) => U
            -

            A function that accepts up to four arguments. The reduceRight method calls -the callbackfn function one time for each element in the array.

            -
          • initialValue: U
            -

            If initialValue is specified, it is used as the initial value to start -the accumulation. The first call to the callbackfn function provides this value as an argument -instead of an array value.

            -

          Returns U

        reverse

        set

        • set(array: ArrayLike<number>, offset?: number): void
        • -

          Sets a value or an array of values.

          -

          Parameters

          • array: ArrayLike<number>
            -

            A typed or untyped array of values to set.

            -
          • Optional offset: number
            -

            The index in the current array at which the values are to be written.

            -

          Returns void

        slice

        • -

          Returns a section of an array.

          -

          Parameters

          • Optional start: number
            -

            The beginning of the specified portion of the array.

            -
          • Optional end: number
            -

            The end of the specified portion of the array. This is exclusive of the element at the index 'end'.

            -

          Returns <internal>.Uint8ClampedArray

        some

        • -

          Determines whether the specified callback function returns true for any element of an array.

          -

          Parameters

          • predicate: (value: number, index: number, array: <internal>.Uint8ClampedArray) => unknown
            -

            A function that accepts up to three arguments. The some method calls -the predicate function for each element in the array until the predicate returns a value -which is coercible to the Boolean value true, or until the end of the array.

            -
          • Optional thisArg: any
            -

            An object to which the this keyword can refer in the predicate function. -If thisArg is omitted, undefined is used as the this value.

            -

          Returns boolean

        sort

        • -

          Sorts an array.

          -

          Parameters

          • Optional compareFn: (a: number, b: number) => number
            -

            Function used to determine the order of the elements. It is expected to return -a negative value if first argument is less than second argument, zero if they're equal and a positive -value otherwise. If omitted, the elements are sorted in ascending, ASCII character order.

            -
            [11,2,22,1].sort((a, b) => a - b)
-
            -
              • (a: number, b: number): number

              • Parameters

                • a: number
                • b: number

                Returns number

          Returns <internal>.Uint8ClampedArray

        subarray

        • -

          Gets a new Uint8ClampedArray view of the ArrayBuffer store for this array, referencing the elements -at begin, inclusive, up to end, exclusive.

          -

          Parameters

          • Optional begin: number
            -

            The index of the beginning of the array.

            -
          • Optional end: number
            -

            The index of the end of the array.

            -

          Returns <internal>.Uint8ClampedArray

        toLocaleString

        • toLocaleString(): string
        • -

          Converts a number to a string by using the current locale.

          -

          Returns string

        toString

        • toString(): string
        • -

          Returns a string representation of an array.

          -

          Returns string

        valueOf

        • -

          Returns the primitive value of the specified object.

          -

          Returns <internal>.Uint8ClampedArray

        values

        • -

          Returns an list of values in the array

          -

          Returns IterableIterator<number>

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.Uint8ClampedArrayConstructor.html b/docs/interfaces/_internal_.Uint8ClampedArrayConstructor.html deleted file mode 100644 index 91f697d..0000000 --- a/docs/interfaces/_internal_.Uint8ClampedArrayConstructor.html +++ /dev/null @@ -1,27 +0,0 @@ -Uint8ClampedArrayConstructor | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Uint8ClampedArrayConstructor

        Hierarchy

        • Uint8ClampedArrayConstructor

        Index

        Constructors

        Properties

        Methods

        Constructors

        constructor

        Properties

        Readonly BYTES_PER_ELEMENT

        BYTES_PER_ELEMENT: number
        -

        The size in bytes of each element in the array.

        -

        Readonly prototype

        prototype: <internal>.Uint8ClampedArray

        Methods

        from

        • -

          Creates an array from an array-like or iterable object.

          -

          Parameters

          • arrayLike: ArrayLike<number>
            -

            An array-like or iterable object to convert to an array.

            -

          Returns <internal>.Uint8ClampedArray

        • -

          Creates an array from an array-like or iterable object.

          -

          Type parameters

          • T

          Parameters

          • arrayLike: ArrayLike<T>
            -

            An array-like or iterable object to convert to an array.

            -
          • mapfn: (v: T, k: number) => number
            -

            A mapping function to call on every element of the array.

            -
              • (v: T, k: number): number

              • Parameters

                • v: T
                • k: number

                Returns number

          • Optional thisArg: any
            -

            Value of 'this' used to invoke the mapfn.

            -

          Returns <internal>.Uint8ClampedArray

        • -

          Creates an array from an array-like or iterable object.

          -

          Parameters

          • arrayLike: Iterable<number>
            -

            An array-like or iterable object to convert to an array.

            -
          • Optional mapfn: (v: number, k: number) => number
            -

            A mapping function to call on every element of the array.

            -
              • (v: number, k: number): number

              • Parameters

                • v: number
                • k: number

                Returns number

          • Optional thisArg: any
            -

            Value of 'this' used to invoke the mapfn.

            -

          Returns <internal>.Uint8ClampedArray

        of

        • -

          Returns a new array from a set of elements.

          -

          Parameters

          • Rest ...items: number[]
            -

            A set of elements to include in the new array object.

            -

          Returns <internal>.Uint8ClampedArray

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.VideoOptions.html b/docs/interfaces/_internal_.VideoOptions.html deleted file mode 100644 index 0ab800b..0000000 --- a/docs/interfaces/_internal_.VideoOptions.html +++ /dev/null @@ -1,31 +0,0 @@ -VideoOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface VideoOptions

        Hierarchy

        • VideoOptions

        Index

        Properties

        Properties

        Optional channel

        channel?: YouTubeChannel
        -

        YouTube Video's uploader Channel Data

        -

        Optional description

        description?: string
        -

        YouTube Video description.

        -

        dislikes

        dislikes: number
        -

        YouTube Video's dislikes

        -

        durationInSec

        durationInSec: number
        -

        YouTube Video Duration in seconds

        -

        durationRaw

        durationRaw: string
        -

        YouTube Video Duration Formatted

        -

        Optional id

        id?: string
        -

        YouTube Video ID

        -

        likes

        likes: number
        -

        YouTube Video's likes

        -

        live

        live: boolean
        -

        YouTube Video live status

        -

        private

        private: boolean
        -

        YouTube Video private status

        -

        tags

        tags: string[]
        -

        YouTube Video tags

        -

        Optional thumbnail

        thumbnail?: { height: undefined | number; id: undefined | string; url: undefined | string; width: undefined | number }
        -

        YouTube Thumbnail Data

        -

        Type declaration

        • height: undefined | number
        • id: undefined | string
        • url: undefined | string
        • width: undefined | number

        Optional title

        title?: string
        -

        YouTube Video title

        -

        Optional uploadedAt

        uploadedAt?: string
        -

        YouTube Video Uploaded Date

        -

        url

        url: string
        -

        YouTube video url

        -

        views

        views: number
        -

        YouTube Views

        -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.WritableStream.html b/docs/interfaces/_internal_.WritableStream.html deleted file mode 100644 index 4ca94ae..0000000 --- a/docs/interfaces/_internal_.WritableStream.html +++ /dev/null @@ -1,135 +0,0 @@ -WritableStream | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface WritableStream

        Hierarchy

        Implemented by

        Index

        Properties

        Methods

        Properties

        writable

        writable: boolean

        Methods

        addListener

        • addListener(eventName: string | symbol, listener: (...args: any[]) => void): WritableStream
        • -

          Alias for emitter.on(eventName, listener).

          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns WritableStream

        emit

        • emit(eventName: string | symbol, ...args: any[]): boolean
        • -

          Synchronously calls each of the listeners registered for the event namedeventName, in the order they were registered, passing the supplied arguments -to each.

          -

          Returns true if the event had listeners, false otherwise.

          -
          const EventEmitter = require('events');
          const myEmitter = new EventEmitter();

          // First listener
          myEmitter.on('event', function firstListener() {
            console.log('Helloooo! first listener');
          });
          // Second listener
          myEmitter.on('event', function secondListener(arg1, arg2) {
            console.log(`event with parameters ${arg1}, ${arg2} in second listener`);
          });
          // Third listener
          myEmitter.on('event', function thirdListener(...args) {
            const parameters = args.join(', ');
            console.log(`event with parameters ${parameters} in third listener`);
          });

          console.log(myEmitter.listeners('event'));

          myEmitter.emit('event', 1, 2, 3, 4, 5);

          // Prints:
          // [
          //   [Function: firstListener],
          //   [Function: secondListener],
          //   [Function: thirdListener]
          // ]
          // Helloooo! first listener
          // event with parameters 1, 2 in second listener
          // event with parameters 1, 2, 3, 4, 5 in third listener
-
          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • Rest ...args: any[]

          Returns boolean

        end

        • Parameters

          • Optional cb: () => void
              • (): void

              • Returns void

          Returns void

        • Parameters

          Returns void

        • Parameters

          • str: string
          • Optional encoding: BufferEncoding
          • Optional cb: () => void
              • (): void

              • Returns void

          Returns void

        eventNames

        • eventNames(): (string | symbol)[]
        • -

          Returns an array listing the events for which the emitter has registered -listeners. The values in the array are strings or Symbols.

          -
          const EventEmitter = require('events');
          const myEE = new EventEmitter();
          myEE.on('foo', () => {});
          myEE.on('bar', () => {});

          const sym = Symbol('symbol');
          myEE.on(sym, () => {});

          console.log(myEE.eventNames());
          // Prints: [ 'foo', 'bar', Symbol(symbol) ]
-
          -
          since

          v6.0.0

          -

          Returns (string | symbol)[]

        getMaxListeners

        • getMaxListeners(): number
        • -

          Returns the current max listener value for the EventEmitter which is either -set by emitter.setMaxListeners(n) or defaults to defaultMaxListeners.

          -
          since

          v1.0.0

          -

          Returns number

        listenerCount

        • listenerCount(eventName: string | symbol): number
        • -

          Returns the number of listeners listening to the event named eventName.

          -
          since

          v3.2.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event being listened for

            -

          Returns number

        listeners

        • -

          Returns a copy of the array of listeners for the event named eventName.

          -
          server.on('connection', (stream) => {
            console.log('someone connected!');
          });
          console.log(util.inspect(server.listeners('connection')));
          // Prints: [ [Function] ]
-
          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol

          Returns <internal>.Function[]

        off

        • off(eventName: string | symbol, listener: (...args: any[]) => void): WritableStream
        • -

          Alias for emitter.removeListener().

          -
          since

          v10.0.0

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns WritableStream

        on

        • on(eventName: string | symbol, listener: (...args: any[]) => void): WritableStream
        • -

          Adds the listener function to the end of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

          -
          server.on('connection', (stream) => {
            console.log('someone connected!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -

          By default, event listeners are invoked in the order they are added. Theemitter.prependListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

          -
          const myEE = new EventEmitter();
          myEE.on('foo', () => console.log('a'));
          myEE.prependListener('foo', () => console.log('b'));
          myEE.emit('foo');
          // Prints:
          //   b
          //   a
-
          -
          since

          v0.1.101

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns WritableStream

        once

        • once(eventName: string | symbol, listener: (...args: any[]) => void): WritableStream
        • -

          Adds a one-timelistener function for the event named eventName. The -next time eventName is triggered, this listener is removed and then invoked.

          -
          server.once('connection', (stream) => {
            console.log('Ah, we have our first user!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -

          By default, event listeners are invoked in the order they are added. Theemitter.prependOnceListener() method can be used as an alternative to add the -event listener to the beginning of the listeners array.

          -
          const myEE = new EventEmitter();
          myEE.once('foo', () => console.log('a'));
          myEE.prependOnceListener('foo', () => console.log('b'));
          myEE.emit('foo');
          // Prints:
          //   b
          //   a
-
          -
          since

          v0.3.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns WritableStream

        prependListener

        • prependListener(eventName: string | symbol, listener: (...args: any[]) => void): WritableStream
        • -

          Adds the listener function to the beginning of the listeners array for the -event named eventName. No checks are made to see if the listener has -already been added. Multiple calls passing the same combination of eventNameand listener will result in the listener being added, and called, multiple -times.

          -
          server.prependListener('connection', (stream) => {
            console.log('someone connected!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v6.0.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns WritableStream

        prependOnceListener

        • prependOnceListener(eventName: string | symbol, listener: (...args: any[]) => void): WritableStream
        • -

          Adds a one-timelistener function for the event named eventName to the_beginning_ of the listeners array. The next time eventName is triggered, this -listener is removed, and then invoked.

          -
          server.prependOnceListener('connection', (stream) => {
            console.log('Ah, we have our first user!');
          });
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v6.0.0

          -

          Parameters

          • eventName: string | symbol
            -

            The name of the event.

            -
          • listener: (...args: any[]) => void
            -

            The callback function

            -
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns WritableStream

        rawListeners

        • -

          Returns a copy of the array of listeners for the event named eventName, -including any wrappers (such as those created by .once()).

          -
          const emitter = new EventEmitter();
          emitter.once('log', () => console.log('log once'));

          // Returns a new Array with a function `onceWrapper` which has a property
          // `listener` which contains the original listener bound above
          const listeners = emitter.rawListeners('log');
          const logFnWrapper = listeners[0];

          // Logs "log once" to the console and does not unbind the `once` event
          logFnWrapper.listener();

          // Logs "log once" to the console and removes the listener
          logFnWrapper();

          emitter.on('log', () => console.log('log persistently'));
          // Will return a new Array with a single function bound by `.on()` above
          const newListeners = emitter.rawListeners('log');

          // Logs "log persistently" twice
          newListeners[0]();
          emitter.emit('log');
-
          -
          since

          v9.4.0

          -

          Parameters

          • eventName: string | symbol

          Returns <internal>.Function[]

        removeAllListeners

        • -

          Removes all listeners, or those of the specified eventName.

          -

          It is bad practice to remove listeners added elsewhere in the code, -particularly when the EventEmitter instance was created by some other -component or module (e.g. sockets or file streams).

          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.1.26

          -

          Parameters

          • Optional event: string | symbol

          Returns WritableStream

        removeListener

        • removeListener(eventName: string | symbol, listener: (...args: any[]) => void): WritableStream
        • -

          Removes the specified listener from the listener array for the event namedeventName.

          -
          const callback = (stream) => {
            console.log('someone connected!');
          };
          server.on('connection', callback);
          // ...
          server.removeListener('connection', callback);
-
          -

          removeListener() will remove, at most, one instance of a listener from the -listener array. If any single listener has been added multiple times to the -listener array for the specified eventName, then removeListener() must be -called multiple times to remove each instance.

          -

          Once an event is emitted, all listeners attached to it at the -time of emitting are called in order. This implies that anyremoveListener() or removeAllListeners() calls after emitting and_before_ the last listener finishes execution will -not remove them fromemit() in progress. Subsequent events behave as expected.

          -
          const myEmitter = new MyEmitter();

          const callbackA = () => {
            console.log('A');
            myEmitter.removeListener('event', callbackB);
          };

          const callbackB = () => {
            console.log('B');
          };

          myEmitter.on('event', callbackA);

          myEmitter.on('event', callbackB);

          // callbackA removes listener callbackB but it will still be called.
          // Internal listener array at time of emit [callbackA, callbackB]
          myEmitter.emit('event');
          // Prints:
          //   A
          //   B

          // callbackB is now removed.
          // Internal listener array [callbackA]
          myEmitter.emit('event');
          // Prints:
          //   A
-
          -

          Because listeners are managed using an internal array, calling this will -change the position indices of any listener registered after the listener -being removed. This will not impact the order in which listeners are called, -but it means that any copies of the listener array as returned by -the emitter.listeners() method will need to be recreated.

          -

          When a single function has been added as a handler multiple times for a single -event (as in the example below), removeListener() will remove the most -recently added instance. In the example the once('ping')listener is removed:

          -
          const ee = new EventEmitter();

          function pong() {
            console.log('pong');
          }

          ee.on('ping', pong);
          ee.once('ping', pong);
          ee.removeListener('ping', pong);

          ee.emit('ping');
          ee.emit('ping');
-
          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.1.26

          -

          Parameters

          • eventName: string | symbol
          • listener: (...args: any[]) => void
              • (...args: any[]): void

              • Parameters

                • Rest ...args: any[]

                Returns void

          Returns WritableStream

        setMaxListeners

        • -

          By default EventEmitters will print a warning if more than 10 listeners are -added for a particular event. This is a useful default that helps finding -memory leaks. The emitter.setMaxListeners() method allows the limit to be -modified for this specific EventEmitter instance. The value can be set toInfinity (or 0) to indicate an unlimited number of listeners.

          -

          Returns a reference to the EventEmitter, so that calls can be chained.

          -
          since

          v0.3.5

          -

          Parameters

          • n: number

          Returns WritableStream

        write

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.formatData.html b/docs/interfaces/_internal_.formatData.html deleted file mode 100644 index 53fb172..0000000 --- a/docs/interfaces/_internal_.formatData.html +++ /dev/null @@ -1 +0,0 @@ -formatData | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface formatData

        Hierarchy

        • formatData

        Index

        Properties

        Properties

        approxDurationMs

        approxDurationMs: string

        audioChannels

        audioChannels: number

        audioQuality

        audioQuality: string

        audioSampleRate

        audioSampleRate: string

        averageBitrate

        averageBitrate: number

        bitrate

        bitrate: number

        cipher

        cipher: string

        contentLength

        contentLength: string

        fps

        fps: number

        height

        height: number

        itag

        itag: number

        lastModified

        lastModified: string

        loudnessDb

        loudnessDb: number

        mimeType

        mimeType: string

        projectionType

        projectionType: string

        quality

        quality: string

        qualityLabel

        qualityLabel: string

        signatureCipher

        signatureCipher: string

        targetDurationSec

        targetDurationSec: number

        url

        url: string

        width

        width: number

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.internal.DuplexOptions.html b/docs/interfaces/_internal_.internal.DuplexOptions.html deleted file mode 100644 index 4567e74..0000000 --- a/docs/interfaces/_internal_.internal.DuplexOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -DuplexOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface DuplexOptions

        Hierarchy

        Index

        Properties

        Methods

        Properties

        Optional allowHalfOpen

        allowHalfOpen?: boolean

        Optional autoDestroy

        autoDestroy?: boolean

        Optional decodeStrings

        decodeStrings?: boolean

        Optional defaultEncoding

        defaultEncoding?: BufferEncoding

        Optional emitClose

        emitClose?: boolean

        Optional encoding

        encoding?: BufferEncoding

        Optional highWaterMark

        highWaterMark?: number

        Optional objectMode

        objectMode?: boolean

        Optional readableHighWaterMark

        readableHighWaterMark?: number

        Optional readableObjectMode

        readableObjectMode?: boolean

        Optional signal

        signal?: <internal>.AbortSignal
        -

        When provided the corresponding AbortController can be used to cancel an asynchronous action.

        -

        Optional writableCorked

        writableCorked?: number

        Optional writableHighWaterMark

        writableHighWaterMark?: number

        Optional writableObjectMode

        writableObjectMode?: boolean

        Methods

        Optional construct

        Optional destroy

        Optional final

        Optional read

        • read(size: number): void

        • Parameters

          • size: number

          Returns void

        Optional write

        Optional writev

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.internal.FinishedOptions.html b/docs/interfaces/_internal_.internal.FinishedOptions.html deleted file mode 100644 index 227e3a6..0000000 --- a/docs/interfaces/_internal_.internal.FinishedOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -FinishedOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface FinishedOptions

        Hierarchy

        Index

        Properties

        Properties

        Optional error

        error?: boolean

        Optional readable

        readable?: boolean

        Optional signal

        signal?: <internal>.AbortSignal
        -

        When provided the corresponding AbortController can be used to cancel an asynchronous action.

        -

        Optional writable

        writable?: boolean

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.internal.Pipe.html b/docs/interfaces/_internal_.internal.Pipe.html deleted file mode 100644 index b4fcbe2..0000000 --- a/docs/interfaces/_internal_.internal.Pipe.html +++ /dev/null @@ -1 +0,0 @@ -Pipe | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface Pipe

        Hierarchy

        • Pipe

        Index

        Methods

        Methods

        close

        • close(): void

        • Returns void

        hasRef

        • hasRef(): boolean

        • Returns boolean

        ref

        • ref(): void

        • Returns void

        unref

        • unref(): void

        • Returns void

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.internal.PipelineOptions.html b/docs/interfaces/_internal_.internal.PipelineOptions.html deleted file mode 100644 index 4c57236..0000000 --- a/docs/interfaces/_internal_.internal.PipelineOptions.html +++ /dev/null @@ -1 +0,0 @@ -PipelineOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface PipelineOptions

        Hierarchy

        • PipelineOptions

        Index

        Properties

        Properties

        signal

        signal: <internal>.AbortSignal

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.internal.ReadableOptions.html b/docs/interfaces/_internal_.internal.ReadableOptions.html deleted file mode 100644 index afd9ed7..0000000 --- a/docs/interfaces/_internal_.internal.ReadableOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -ReadableOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface ReadableOptions

        Hierarchy

        Index

        Properties

        Methods

        Properties

        Optional autoDestroy

        autoDestroy?: boolean

        Optional emitClose

        emitClose?: boolean

        Optional encoding

        encoding?: BufferEncoding

        Optional highWaterMark

        highWaterMark?: number

        Optional objectMode

        objectMode?: boolean

        Optional signal

        signal?: <internal>.AbortSignal
        -

        When provided the corresponding AbortController can be used to cancel an asynchronous action.

        -

        Methods

        Optional construct

        Optional destroy

        Optional read

        • read(size: number): void

        • Parameters

          • size: number

          Returns void

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.internal.StreamOptions.html b/docs/interfaces/_internal_.internal.StreamOptions.html deleted file mode 100644 index 11cf3a1..0000000 --- a/docs/interfaces/_internal_.internal.StreamOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -StreamOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface StreamOptions<T>

        Type parameters

        Hierarchy

        Index

        Properties

        Methods

        Properties

        Optional autoDestroy

        autoDestroy?: boolean

        Optional emitClose

        emitClose?: boolean

        Optional highWaterMark

        highWaterMark?: number

        Optional objectMode

        objectMode?: boolean

        Optional signal

        signal?: <internal>.AbortSignal
        -

        When provided the corresponding AbortController can be used to cancel an asynchronous action.

        -

        Methods

        Optional construct

        Optional destroy

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.internal.TransformOptions.html b/docs/interfaces/_internal_.internal.TransformOptions.html deleted file mode 100644 index 9dbb411..0000000 --- a/docs/interfaces/_internal_.internal.TransformOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -TransformOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface TransformOptions

        Hierarchy

        Index

        Properties

        Methods

        Properties

        Optional allowHalfOpen

        allowHalfOpen?: boolean

        Optional autoDestroy

        autoDestroy?: boolean

        Optional decodeStrings

        decodeStrings?: boolean

        Optional defaultEncoding

        defaultEncoding?: BufferEncoding

        Optional emitClose

        emitClose?: boolean

        Optional encoding

        encoding?: BufferEncoding

        Optional highWaterMark

        highWaterMark?: number

        Optional objectMode

        objectMode?: boolean

        Optional readableHighWaterMark

        readableHighWaterMark?: number

        Optional readableObjectMode

        readableObjectMode?: boolean

        Optional signal

        signal?: <internal>.AbortSignal
        -

        When provided the corresponding AbortController can be used to cancel an asynchronous action.

        -

        Optional writableCorked

        writableCorked?: number

        Optional writableHighWaterMark

        writableHighWaterMark?: number

        Optional writableObjectMode

        writableObjectMode?: boolean

        Methods

        Optional construct

        Optional destroy

        Optional final

        Optional flush

        • Parameters

          Returns void

        Optional read

        • read(size: number): void

        • Parameters

          • size: number

          Returns void

        Optional transform

        Optional write

        Optional writev

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.internal.WritableOptions.html b/docs/interfaces/_internal_.internal.WritableOptions.html deleted file mode 100644 index ec4fc42..0000000 --- a/docs/interfaces/_internal_.internal.WritableOptions.html +++ /dev/null @@ -1,3 +0,0 @@ -WritableOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface WritableOptions

        Hierarchy

        Index

        Properties

        Methods

        Properties

        Optional autoDestroy

        autoDestroy?: boolean

        Optional decodeStrings

        decodeStrings?: boolean

        Optional defaultEncoding

        defaultEncoding?: BufferEncoding

        Optional emitClose

        emitClose?: boolean

        Optional highWaterMark

        highWaterMark?: number

        Optional objectMode

        objectMode?: boolean

        Optional signal

        signal?: <internal>.AbortSignal
        -

        When provided the corresponding AbortController can be used to cancel an asynchronous action.

        -

        Methods

        Optional construct

        Optional destroy

        Optional final

        Optional write

        Optional writev

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/interfaces/_internal_.tokenOptions.html b/docs/interfaces/_internal_.tokenOptions.html deleted file mode 100644 index 0b0d342..0000000 --- a/docs/interfaces/_internal_.tokenOptions.html +++ /dev/null @@ -1 +0,0 @@ -tokenOptions | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Interface tokenOptions

        Hierarchy

        • tokenOptions

        Index

        Properties

        Properties

        Optional soundcloud

        soundcloud?: { client_id: string }

        Type declaration

        • client_id: string

        Optional spotify

        spotify?: { client_id: string; client_secret: string; market: string; refresh_token: string }

        Type declaration

        • client_id: string
        • client_secret: string
        • market: string
        • refresh_token: string

        Optional youtube

        youtube?: { cookie: string }

        Type declaration

        • cookie: string

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method
        • Property

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules.html b/docs/modules.html deleted file mode 100644 index a745862..0000000 --- a/docs/modules.html +++ /dev/null @@ -1,134 +0,0 @@ -play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        play-dl

        Index

        Namespaces

        Classes

        Type aliases

        Functions

        Type aliases

        Deezer

        Deezer: DeezerTrack | DeezerPlaylist | DeezerAlbum
        -

        Shared type for Deezer tracks, playlists and albums

        -

        SoundCloud

        SoundCloud: SoundCloudTrack | SoundCloudPlaylist
        -

        Type of SoundCloud

        -

        Spotify

        Spotify: SpotifyAlbum | SpotifyPlaylist | SpotifyTrack
        -

        type for Spotify Class

        -

        YouTube

        YouTube: YouTubeVideo | YouTubeChannel | YouTubePlayList
        -

        Type for YouTube returns

        -

        YouTubeStream

        YouTubeStream: <internal>.Stream | LiveStream
        -

        Type for YouTube Stream

        -

        Functions

        attachListeners

        authorization

        • authorization(): void

        cookieHeaders

        • cookieHeaders(headCookie: string[]): void

        decipher_info

        deezer

        dz_advanced_track_search

        • -

          Searches Deezer for tracks using the specified metadata.

          -

          Parameters

          • options: DeezerAdvancedSearchOptions
            -

            The metadata and limit for the search

            -
              -
            • limit?: The maximum number of results to return, maximum 100, defaults to 10.
              • -
            • artist?: The name of the artist
              • -
            • album?: The title of the album
              • -
            • title?: The title of the track
              • -
            • label?: The label that released the track
              • -
            • minDurationInSec?: The minimum duration in seconds
              • -
            • maxDurationInSec?: The maximum duration in seconds
              • -
            • minBpm?: The minimum BPM
              • -
            • maxBpm?: The minimum BPM
              • -
            -

          Returns <internal>.Promise<DeezerTrack[]>

          An array of tracks matching the metadata

          -

        dz_validate

        • dz_validate(url: string): <internal>.Promise<"track" | "playlist" | "album" | "search" | false>
        • -

          Validates a Deezer URL

          -

          Parameters

          • url: string
            -

            The URL to validate

            -

          Returns <internal>.Promise<"track" | "playlist" | "album" | "search" | false>

          The type of the URL either 'track', 'playlist', 'album', 'search' or false. -false means that the provided URL was a wrongly formatted or unsupported Deezer URL.

          -

        extractID

        • extractID(url: string): string

        getFreeClientID

        is_expired

        • is_expired(): boolean

        playlist_info

        refreshToken

        search

        setToken

        so_validate

        • so_validate(url: string): <internal>.Promise<false | "track" | "playlist" | "search">

        soundcloud

        sp_validate

        • sp_validate(url: string): "track" | "playlist" | "album" | "search" | false
        • -

          Function to validate Spotify url

          -

          Parameters

          • url: string
            -

            url for validation

            -

          Returns "track" | "playlist" | "album" | "search" | false

          type of url or false.

          -

        spotify

        stream

        stream_from_info

        validate

        • validate(url: string): <internal>.Promise<"so_playlist" | "so_track" | "sp_track" | "sp_album" | "sp_playlist" | "dz_track" | "dz_playlist" | "dz_album" | "yt_video" | "yt_playlist" | "search" | false>
        • -

          Command to validate the provided url. It checks whether it supports play-dl or not.

          -

          Parameters

          • url: string
            -

            url to validate

            -

          Returns <internal>.Promise<"so_playlist" | "so_track" | "sp_track" | "sp_album" | "sp_playlist" | "dz_track" | "dz_playlist" | "dz_album" | "yt_video" | "yt_playlist" | "search" | false>

          On failure, returns false else type of url.

          -

        video_basic_info

        video_info

        yt_validate

        • yt_validate(url: string): "playlist" | "video" | "search" | false
        • -

          Command to validate a YouTube url

          -

          Parameters

          • url: string
            -

            Url for validation

            -

          Returns "playlist" | "video" | "search" | false

          type of url or false.

          -

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules/_internal_.EventEmitter.html b/docs/modules/_internal_.EventEmitter.html deleted file mode 100644 index 5a3d79a..0000000 --- a/docs/modules/_internal_.EventEmitter.html +++ /dev/null @@ -1 +0,0 @@ -EventEmitter | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace EventEmitter

        Index

        References

        Interfaces

        References

        EventEmitter

        Re-exports EventEmitter

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules/_internal_._node_stream_consumers_.html b/docs/modules/_internal_._node_stream_consumers_.html deleted file mode 100644 index d58153e..0000000 --- a/docs/modules/_internal_._node_stream_consumers_.html +++ /dev/null @@ -1 +0,0 @@ -"node:stream/consumers" | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace "node:stream/consumers"

        Index

        Functions

        Functions

        arrayBuffer

        blob

        buffer

        json

        text

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules/_internal_._node_stream_promises_.html b/docs/modules/_internal_._node_stream_promises_.html deleted file mode 100644 index 1332210..0000000 --- a/docs/modules/_internal_._node_stream_promises_.html +++ /dev/null @@ -1 +0,0 @@ -"node:stream/promises" | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace "node:stream/promises"

        Index

        Functions

        Functions

        finished

        pipeline

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules/_internal_.html b/docs/modules/_internal_.html deleted file mode 100644 index 4171f18..0000000 --- a/docs/modules/_internal_.html +++ /dev/null @@ -1,7 +0,0 @@ -<internal> | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace <internal>

        Index

        Namespaces

        Enumerations

        Classes

        Interfaces

        Type aliases

        Variables

        Type aliases

        ArrayBufferLike

        ArrayBufferLike: ArrayBufferTypes[keyof ArrayBufferTypes]

        ArrayBufferView

        ArrayBufferView: TypedArray | <internal>.DataView

        BufferEncoding

        BufferEncoding: "ascii" | "utf8" | "utf-8" | "utf16le" | "ucs2" | "ucs-2" | "base64" | "base64url" | "latin1" | "binary" | "hex"

        IteratorResult

        IteratorResult<T, TReturn>: IteratorYieldResult<T> | IteratorReturnResult<TReturn>

        Type parameters

        • T

        • TReturn = any

        LookupFunction

        LookupFunction: (hostname: string, options: LookupOneOptions, callback: (err: ErrnoException | null, address: string, family: number) => void) => void

        Type declaration

        Partial

        Partial<T>: { [ P in keyof T]?: T[P] }
        -

        Make all properties in T optional

        -

        Type parameters

        • T

        PromiseSettledResult

        PromiseSettledResult<T>: PromiseFulfilledResult<T> | PromiseRejectedResult

        Type parameters

        • T

        PropertyKey

        PropertyKey: string | number | symbol

        ProxyOptions

        ProxyOptions: ProxyOpts | string

        Readonly

        Readonly<T>: { readonly [ P in keyof T]: T[P] }
        -

        Make all properties in T readonly

        -

        Type parameters

        • T

        SocketConnectOpts

        SocketConnectOpts: TcpSocketConnectOpts | IpcSocketConnectOpts

        TypedArray

        TypedArray: <internal>.Uint8Array | <internal>.Uint8ClampedArray | <internal>.Uint16Array | <internal>.Uint32Array | <internal>.Int8Array | <internal>.Int16Array | <internal>.Int32Array | <internal>.BigUint64Array | <internal>.BigInt64Array | <internal>.Float32Array | <internal>.Float64Array

        WithImplicitCoercion

        WithImplicitCoercion<T>: T | { valueOf: any }

        Type parameters

        • T

        Variables

        AbortSignal

        AbortSignal: { prototype: <internal>.AbortSignal }

        Type declaration

        ArrayBuffer

        ArrayBuffer: ArrayBufferConstructor

        BigInt64Array

        BigInt64Array: BigInt64ArrayConstructor

        BigUint64Array

        BigUint64Array: BigUint64ArrayConstructor

        Buffer

        Buffer: BufferConstructor

        DataView

        DataView: DataViewConstructor

        Date

        Date: DateConstructor

        Error

        Error: ErrorConstructor

        Float32Array

        Float32Array: Float32ArrayConstructor

        Float64Array

        Float64Array: Float64ArrayConstructor

        Function

        Function: FunctionConstructor

        Int16Array

        Int16Array: Int16ArrayConstructor

        Int32Array

        Int32Array: Int32ArrayConstructor

        Int8Array

        Int8Array: Int8ArrayConstructor

        Map

        Map: MapConstructor

        Object

        Object: ObjectConstructor
        -

        Provides functionality common to all JavaScript objects.

        -

        Promise

        Promise: PromiseConstructor

        SharedArrayBuffer

        SharedArrayBuffer: SharedArrayBufferConstructor

        Uint16Array

        Uint16Array: Uint16ArrayConstructor

        Uint32Array

        Uint32Array: Uint32ArrayConstructor

        Uint8Array

        Uint8Array: Uint8ArrayConstructor

        Uint8ClampedArray

        Uint8ClampedArray: Uint8ClampedArrayConstructor

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules/_internal_.internal.finished.html b/docs/modules/_internal_.internal.finished.html deleted file mode 100644 index b48c922..0000000 --- a/docs/modules/_internal_.internal.finished.html +++ /dev/null @@ -1 +0,0 @@ -finished | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace finished

        Index

        Functions

        Functions

        __promisify__

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules/_internal_.internal.html b/docs/modules/_internal_.internal.html deleted file mode 100644 index f845c4e..0000000 --- a/docs/modules/_internal_.internal.html +++ /dev/null @@ -1,90 +0,0 @@ -internal | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace internal

        Index

        Namespaces

        Classes

        Interfaces

        Type aliases

        Variables

        Functions

        Type aliases

        PipelineCallback

        PipelineCallback<S>: S extends PipelineDestinationPromiseFunction<any, infer P> ? (err: ErrnoException | null, value: P) => void : (err: ErrnoException | null) => void

        Type parameters

        PipelineDestination

        PipelineDestination<S, P>: S extends PipelineTransformSource<infer ST> ? WritableStream | PipelineDestinationIterableFunction<ST> | PipelineDestinationPromiseFunction<ST, P> : never

        Type parameters

        PipelineDestinationIterableFunction

        PipelineDestinationIterableFunction<T>: (source: AsyncIterable<T>) => AsyncIterable<any>

        Type parameters

        • T

        Type declaration

        PipelineDestinationPromiseFunction

        PipelineDestinationPromiseFunction<T, P>: (source: AsyncIterable<T>) => <internal>.Promise<P>

        Type parameters

        • T

        • P

        Type declaration

        PipelinePromise

        PipelinePromise<S>: S extends PipelineDestinationPromiseFunction<any, infer P> ? <internal>.Promise<P> : <internal>.Promise<void>

        Type parameters

        PipelineSource

        PipelineSource<T>: Iterable<T> | AsyncIterable<T> | ReadableStream | PipelineSourceFunction<T>

        Type parameters

        • T

        PipelineSourceFunction

        PipelineSourceFunction<T>: () => Iterable<T> | AsyncIterable<T>

        Type parameters

        • T

        Type declaration

        PipelineTransform

        PipelineTransform<S, U>: ReadWriteStream | ((source: S extends (...args: any[]) => Iterable<infer ST> | AsyncIterable<infer ST> ? AsyncIterable<ST> : S) => AsyncIterable<U>)

        Type parameters

        PipelineTransformSource

        PipelineTransformSource<T>: PipelineSource<T> | PipelineTransform<any, T>

        Type parameters

        • T

        TransformCallback

        TransformCallback: (error?: <internal>.Error | null, data?: any) => void

        Type declaration

        Variables

        consumers

        consumers: typeof "node:stream/consumers"

        promises

        promises: typeof "node:stream/promises"

        Functions

        addAbortSignal

        • -

          Attaches an AbortSignal to a readable or writeable stream. This lets code -control stream destruction using an AbortController.

          -

          Calling abort on the AbortController corresponding to the passedAbortSignal will behave the same way as calling .destroy(new AbortError())on the stream.

          -
          const fs = require('fs');

          const controller = new AbortController();
          const read = addAbortSignal(
            controller.signal,
            fs.createReadStream(('object.json'))
          );
          // Later, abort the operation closing the stream
          controller.abort();
-
          -

          Or using an AbortSignal with a readable stream as an async iterable:

          -
          const controller = new AbortController();
          setTimeout(() => controller.abort(), 10_000); // set a timeout
          const stream = addAbortSignal(
            controller.signal,
            fs.createReadStream(('object.json'))
          );
          (async () => {
            try {
              for await (const chunk of stream) {
                await process(chunk);
              }
            } catch (e) {
              if (e.name === 'AbortError') {
                // The operation was cancelled
              } else {
                throw e;
              }
            }
          })();
-
          -
          since

          v15.4.0

          -

          Type parameters

          Parameters

          • signal: <internal>.AbortSignal
            -

            A signal representing possible cancellation

            -
          • stream: T
            -

            a stream to attach a signal to

            -

          Returns T

        finished

        • -

          A function to get notified when a stream is no longer readable, writable -or has experienced an error or a premature close event.

          -
          const { finished } = require('stream');

          const rs = fs.createReadStream('archive.tar');

          finished(rs, (err) => {
            if (err) {
              console.error('Stream failed.', err);
            } else {
              console.log('Stream is done reading.');
            }
          });

          rs.resume(); // Drain the stream.
-
          -

          Especially useful in error handling scenarios where a stream is destroyed -prematurely (like an aborted HTTP request), and will not emit 'end'or 'finish'.

          -

          The finished API provides promise version:

          -
          const { finished } = require('stream/promises');

          const rs = fs.createReadStream('archive.tar');

          async function run() {
            await finished(rs);
            console.log('Stream is done reading.');
          }

          run().catch(console.error);
          rs.resume(); // Drain the stream.
-
          -

          stream.finished() leaves dangling event listeners (in particular'error', 'end', 'finish' and 'close') after callback has been -invoked. The reason for this is so that unexpected 'error' events (due to -incorrect stream implementations) do not cause unexpected crashes. -If this is unwanted behavior then the returned cleanup function needs to be -invoked in the callback:

          -
          const cleanup = finished(rs, (err) => {
            cleanup();
            // ...
          });
-
          -
          since

          v10.0.0

          -

          Parameters

          Returns () => void

          A cleanup function which removes all registered listeners.

          -
            • (): void
            • -

              A function to get notified when a stream is no longer readable, writable -or has experienced an error or a premature close event.

              -
              const { finished } = require('stream');

              const rs = fs.createReadStream('archive.tar');

              finished(rs, (err) => {
                if (err) {
                  console.error('Stream failed.', err);
                } else {
                  console.log('Stream is done reading.');
                }
              });

              rs.resume(); // Drain the stream.
-
              -

              Especially useful in error handling scenarios where a stream is destroyed -prematurely (like an aborted HTTP request), and will not emit 'end'or 'finish'.

              -

              The finished API provides promise version:

              -
              const { finished } = require('stream/promises');

              const rs = fs.createReadStream('archive.tar');

              async function run() {
                await finished(rs);
                console.log('Stream is done reading.');
              }

              run().catch(console.error);
              rs.resume(); // Drain the stream.
-
              -

              stream.finished() leaves dangling event listeners (in particular'error', 'end', 'finish' and 'close') after callback has been -invoked. The reason for this is so that unexpected 'error' events (due to -incorrect stream implementations) do not cause unexpected crashes. -If this is unwanted behavior then the returned cleanup function needs to be -invoked in the callback:

              -
              const cleanup = finished(rs, (err) => {
                cleanup();
                // ...
              });
-
              -
              since

              v10.0.0

              -

              Returns void

              A cleanup function which removes all registered listeners.

              -

        • Parameters

          Returns () => void

            • (): void

            • Returns void

        pipeline

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file diff --git a/docs/modules/_internal_.internal.pipeline.html b/docs/modules/_internal_.internal.pipeline.html deleted file mode 100644 index 7a0fc46..0000000 --- a/docs/modules/_internal_.internal.pipeline.html +++ /dev/null @@ -1 +0,0 @@ -pipeline | play-dl
        Options
        All
        • Public
        • Public/Protected
        • All
        Menu

        Namespace pipeline

        Index

        Functions

        Functions

        __promisify__

        Legend

        • Constructor
        • Property
        • Method
        • Private property
        • Private method

        Settings

        Theme

        Generated using TypeDoc

        \ No newline at end of file